Flexomatic81
068446fbbf
- Fix all ASCII umlauts (ue/ae/oe) to proper Unicode (ü/ä/ö/ß) - Add missing setup step: build shared package before first start - Add docs/integrations/ with PlentyONE Swagger spec to project structure - Add user-preferences module and docker:ps script - Fix Keycloak client name to tos-nextauth (actual config) - Add note about manual tos-nextauth client creation - Remove non-existent test section (no tests yet) - Remove unnecessary root .env.example copy step Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 line
2.6 MiB
1 line
2.6 MiB
{"swagger":"2.0","info":{"version":"1.0.0","title":"plentyONE REST-API","x-logo":{"url":"https:\/\/cdn01.plentymarkets.com\/avw8j9fg70hi\/frontend\/Logos_PlentyONE\/PlentyONE_Logo_White_RGB.png","backgroundColor":"#FFFFFF"},"description":"The plentyONE REST API expands the functionality of the plentyONE CMS and allows access to resources, i.e. data records, via unique URI paths","contact":{"name":"plentyONE","url":"https:\/\/help.plentyone.com"}},"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":"AuditLog","description":"Routes for AuditLog","externalDocs":{"description":"For the old documentation click here","url":"https:\/\/developers.plentymarkets.com\/rest-doc\/audit_log"}},{"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":"BI","description":"Routes for BI","externalDocs":{"description":"For the old documentation click here","url":"https:\/\/developers.plentymarkets.com\/rest-doc\/b_i"}},{"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":"Catalog","description":"Routes for Catalog","externalDocs":{"description":"For the old documentation click here","url":"https:\/\/developers.plentymarkets.com\/rest-doc\/catalog"}},{"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":"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":"MailTemplates","description":"Routes for MailTemplates","externalDocs":{"description":"For the old documentation click here","url":"https:\/\/developers.plentymarkets.com\/rest-doc\/mail_templates"}},{"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":"Returns","description":"Routes for Returns","externalDocs":{"description":"For the old documentation click here","url":"https:\/\/developers.plentymarkets.com\/rest-doc\/returns"}},{"name":"ShopBuilder","description":"Routes for ShopBuilder","externalDocs":{"description":"For the old documentation click here","url":"https:\/\/developers.plentymarkets.com\/rest-doc\/shop_builder"}},{"name":"Stock","description":"Routes for Stock","externalDocs":{"description":"For the old documentation click here","url":"https:\/\/developers.plentymarkets.com\/rest-doc\/stock"}},{"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":"Todo","description":"Routes for Todo","externalDocs":{"description":"For the old documentation click here","url":"https:\/\/developers.plentymarkets.com\/rest-doc\/todo"}},{"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":"Export an elastic export.","description":"Export an elastic export. The export ID must be specified.","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":"Export an elastic export.","description":"Export an elastic export. The export ID must be specified.","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 frontend user","description":"Logs in to the online store with frontend 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","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 access token","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 frontend user","description":"Logs out the frontend 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"},"examples":{"application\/json":{"name":"Lebanon","clientId":2216259,"countryId":317,"plentyId":16052}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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":"Get all unique posting accounts from the PostingAccountRepositoryContract.","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":"Get all posting accounts from the PostingAccountRepositoryContract.","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":"Save all posting accounts.","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 a posting account","description":"Delete a posting account specified by the id.","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":"Get posting account","description":"Gets posting account by the unique id","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"id":1863019,"locationId":1,"accountEu":"8592","accountExport":"6481"},{"id":39803603,"locationId":1,"accountEu":"5546","accountExport":"9285"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"name":"Canada","clientId":1936003,"countryId":312,"plentyId":19696}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"name":"Finland","clientId":1381311,"countryId":318,"plentyId":19086}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"countryId":241,"revenueAccountLocationId":363,"revenueAccounts":[{"id":0,"account":95537},{"id":1,"account":17788},{"id":2,"account":93500},{"id":3,"account":50931},{"id":4,"account":31364},{"id":5,"account":16719}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"id":47372,"locationId":1,"mode":"country_payment","sequence":"FNV","standard":"2632","save":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 debtor account configuration of an accounting location","description":"Updates the debtor account configuration of an accounting location. The ID of the accounting location has to be specified.","tags":["Accounting"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DebtorAccountConfiguration"},"examples":{"application\/json":{"id":52062849,"locationId":1,"mode":"payment","sequence":"NVF","standard":"6889","save":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/debtor_account_configurations","schema":{"type":"object","properties":{"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\ncharacter = 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.\npayment = The debtor accounts are selected based on the payment method.\ncountry = The debtor accounts are selected based on the country of delivery.\ncountry_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.\n allowed values are character, payment, country, country_payment"},"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\nFNV = stands for the sequence: company, lastname, firstname\nNVF = stands for the sequence: lastname, firstname, company\nNFV = stands for the sequence: lastname, company, firstname\n allowed values are FNV, NVF, NFV"},"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."},"accounts":{"type":"array","items":{}}}}}]}},"\/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 <ul>\n <li>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 <li>payment = The debtor accounts are selected based on the payment method.<\/li>\n <li>country = The debtor accounts are selected based on the country of delivery.<\/li>\n <li>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>","format":"string","in":"path"}]}},"\/rest\/accounting\/locations\/{locationId}\/posting_accounts":{"get":{"summary":"Get posting accounts by locationId","description":"Get all posting accounts by locationId.","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."}},"parameters":[{"name":"locationId","type":"integer","required":true,"description":"The ID of the accounting location.","format":"integer","in":"path"}]}},"\/rest\/accounting\/locations\/{locationId}\/posting_key_configurations":{"get":{"summary":"Get a posting key configuration of an accounting location","description":"Gets a posting key configuration of an accounting location. The ID of the accounting location has to be specified. The posting key configuration can contain up to 4 posting keys.","tags":["Accounting"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PostingKeyConfiguration"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 a posting key configuration of an accounting location","description":"Updates a posting key configuration of an accounting location. The ID of the accounting location has to be specified.","tags":["Accounting"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PostingKeyConfiguration"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/posting_key_configurations","schema":{"type":"object","properties":{"postingKeys":{"type":"array","items":{}}}}}]}},"\/rest\/accounting\/locations\/{locationId}\/revenue_account_configurations":{"get":{"summary":"Get the revenue account configuration of an accounting location","description":"Gets the revenue account configuration of an accounting location. A revenue account location configuration contains several revenue accounts. The ID of the accounting location has to be specified.","tags":["Accounting"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/RevenueAccountLocationConfiguration"},"examples":{"application\/json":{"id":760,"locationId":1,"accountEu":"2953","accountExport":"1566"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 the revenue account configuration of an accounting location","description":"Updates the revenue account configuration of an accounting location. The ID of the accounting location has to be specified.","tags":["Accounting"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/RevenueAccountLocationConfiguration"},"examples":{"application\/json":{"id":47,"locationId":1,"accountEu":"3374","accountExport":"7298"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/revenue_account_configurations","schema":{"type":"object","properties":{"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"},"revenueAccountCountryConfigurations":{"type":"array","items":{}}}}}]}},"\/rest\/accounting\/locations\/{locationId}\/settings":{"get":{"summary":"Get accounting location settings","description":"Gets accounting location settings. The ID of the accounting location must be specified.","tags":["Accounting"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AccountingLocationSettings"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 accounting location settings","description":"Updates accounting location settings. The ID of the accounting location must be specified.","tags":["Accounting"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AccountingLocationSettings"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/settings","schema":{"type":"object","properties":{"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 allowed values are 2, 4"},"roundTotalsOnly":{"type":"boolean","description":"Do only round totals?"}}}}]}},"\/rest\/accounting\/locations\/{locationId}\/{type}\/posting_accounts":{"get":{"summary":"Get posting accounts by locationId and type","description":"Get all posting accounts by locationId and type.","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."}},"parameters":[{"name":"locationId","type":"integer","required":true,"description":"The ID of the accounting location.","format":"integer","in":"path"},{"name":"type","type":"string","required":true,"description":"The type of the PostingAccount.","format":"string","in":"path"}]}},"\/rest\/accounting\/locations\/{webstoreId}\/{countryId}\/posting_accounts":{"get":{"summary":"Get posting accounts by country and webstore","description":"Get all posting accounts for a country of a webstore.","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."}},"parameters":[{"name":"countryId","type":"integer","required":true,"description":"The ID of the country","format":"integer","in":"path"},{"name":"$webstoreId","type":"integer","required":true,"description":"The ID of the webstore","format":"integer","in":"query"},{"name":"webstoreId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/accounting\/stores\/locations":{"get":{"summary":"List accounting locations","description":"List all accounting locations","tags":["Accounting"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/AccountingLocation"}},"examples":{"application\/json":[{"name":"Finland","clientId":6627110,"countryId":315,"plentyId":19933},{"name":"United States of America","clientId":6775717,"countryId":316,"plentyId":10741}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/stores\/{plentyId}\/locations":{"get":{"summary":"List accounting locations of a client","description":"Lists accounting locations of a client. The plenty ID of the client must be specified.","tags":["Accounting"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/AccountingLocation"}},"examples":{"application\/json":[{"name":"Palau","clientId":2981033,"countryId":313,"plentyId":12563},{"name":"Maldives","clientId":4982248,"countryId":314,"plentyId":12671}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/accounts":{"get":{"summary":"List companies","description":"Lists all companies. An account is equivalent to a company.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/Account"}},"examples":{"application\/json":[{"number":"Nobis corrupti nihil suscipit id aut et. Non quidem qui quia dicta. Quasi qui impedit deleniti blanditiis earum at iste.","companyName":"Nikolaus-Quitzon Ltd","taxIdNumber":"Porro repellendus qui enim.","valuta":7541787227,"discountDays":194,"discountPercent":23,"timeForPaymentAllowedDays":153,"userId":7,"createdAt":"2000-06-06T15:29:16+02:00","updatedAt":"2015-09-14T19:59:32+02:00"},{"number":"Est iusto occaecati aspernatur vel vero. Voluptas in perferendis voluptatem quaerat. Sunt et rerum rem doloribus.","companyName":"Kuhlman, Greenfelder and DuBuque and Sons","taxIdNumber":"Magnam ut vel sint sit.","valuta":9065396487,"discountDays":94,"discountPercent":5,"timeForPaymentAllowedDays":227,"userId":6,"createdAt":"1986-10-21T09:32:33+01:00","updatedAt":"2021-10-12T15:30:39+02:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 that restricts the search result to accounts that were updated according\n * to given filters.\n <br> Usage: <ul>\n <li>'updatedAt=between:yyyy-mm-dd,yyyy-mm-dd'<\/li>\n <li>'updatedAt=eq:yyyy-mm-dd' (=)<\/li>\n <li>'updatedAt=gt:yyyy-mm-dd' (>)<\/li>\n <li>'updatedAt=gte:yyyy-mm-dd' (>=)<\/li>\n <li>'updatedAt=lt:yyyy-mm-dd' (<)<\/li>\n <li>'updatedAt=lte:yyyy-mm-dd' (<=)<\/li>\n <li>Dates can also include the time. Example: 2017-03-08 13:24:17<\/li>\n <li>Without including the time we will use 00:00:00 as default. Example: 2017-03-08 00:00:00<\/li>\n <\/ul>","format":"string","in":"query"},{"name":"createdAt","type":"string","required":false,"description":"Filter that restricts the search result to accounts that were created according\n * to given filters.\n <br> Usage: <ul>\n <li>'createdAt=between:yyyy-mm-dd,yyyy-mm-dd'<\/li>\n <li>'createdAt=eq:yyyy-mm-dd' (=)<\/li>\n <li>'createdAt=gt:yyyy-mm-dd' (>)<\/li>\n <li>'createdAt=gte:yyyy-mm-dd' (>=)<\/li>\n <li>'createdAt=lt:yyyy-mm-dd' (<)<\/li>\n <li>'createdAt=lte:yyyy-mm-dd' (<=)<\/li>\n <li>Dates can also include the time. Example: 2017-03-08 13:24:17<\/li>\n <li>Without including the time we will use 00:00:00 as default. Example: 2017-03-08 00:00:00<\/li>\n <\/ul>","format":"string","in":"query"},{"name":"id","type":"integer","required":false,"description":"Filter that restricts the search result to companies that have an ID according\n * to given filters.\n <br> Usage: <ul>\n <li>'id=eq:ID' (=) <\/li>\n <\/ul>","format":"integer","in":"query"},{"name":"companyName","type":"string","required":false,"description":"Filter that restricts the search result to companies that have a company name according\n * to given filters.\n <br> Usage: <ul>\n <li>'companyName=like:expamle'<\/li>\n <li>'companyName=eq:example' (=)<\/li>\n <\/ul>","format":"string","in":"query"},{"name":"userId","type":"integer","required":false,"description":"Filter that restricts the search result to companies that have a userId \/ ownerId according\n * to given filters.\n <br> Usage: <ul>\n <li>'userId=eq:ID' (=) <\/li>\n <\/ul>","format":"integer","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"Enables the sorting of fields. SortBy has as parameter.\n * The name of the field will also be sorted.","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"Enables to sort the result in an ascending and descending order.\n * When you want to sort the results in ascending order, use <code>asc<\/code>.\n * When you want to sort the result in descending order, use <code>desc<\/code>.","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":"string","required":false,"description":"Includes the specified contact information in the results.\n * The following parameters are available:\n * <code>contacts<\/code>,\n * <code>contactRelations<\/code>,\n * <code>contactsPrimaryBillingAddress<\/code>,\n * <code>salesRepresentativeRegions<\/code>.\n * More than one parameter should be separated by commas","format":"string","in":"query"}]},"post":{"summary":"Create company","description":"Creates a company. An account is equivalent to a company.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Account"},"examples":{"application\/json":{"number":"Et dolorem earum reiciendis ex rerum. At ex dicta eum natus consequatur. Voluptas minima adipisci inventore illo sequi nihil.","companyName":"Will PLC Inc","taxIdNumber":"Quis rerum quaerat et nisi.","valuta":4219605124,"discountDays":93,"discountPercent":92,"timeForPaymentAllowedDays":53,"userId":12,"createdAt":"1987-12-14T12:07:28+01:00","updatedAt":"1978-11-06T11:43:36+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/accounts","schema":{"type":"object","properties":{"number":{"type":"string","description":"The number of the account optional"},"companyName":{"type":"string","description":"The company name"},"taxIdNumber":{"type":"string","description":"The ID of the tax number optional"},"discountPercent":{"type":"number","description":"The early payment discount in percent specified for the account optional"},"valuta":{"type":"integer","description":"The valuta date in days specified for the account optional"},"discountDays":{"type":"integer","description":"The early payment discount period in days specified for the account optional"},"timeForPaymentAllowedDays":{"type":"integer","description":"The payment due date in days specified for the account optional"},"salesRepresentativeContactId":{"type":"integer","description":"The contact ID of the sales representative optional"},"userId":{"type":"integer","description":"The ID of the account owner optional"},"deliveryTime":{"type":"integer","description":"The delivery time for the supplier optional"},"dealerMinOrderValue":{"type":"number","description":"The minimum order value for the supplier optional"},"supplierCurrency":{"type":"string","description":"The currency used by a supplier optional"},"externalId":{"type":"string","description":"The externalId for this company (like the hubspot company id) optional"}}}}]}},"\/rest\/accounts\/addresses":{"get":{"summary":"Get addresses","description":"Get all available addresses","tags":["Account"],"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 Address","items":{"$ref":"#\/definitions\/Address"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"gender":"diverse","name1":"Bechtelar-Nienow","name2":"Willis","name3":"Spinka","name4":"renner.antone","address1":"Raina Club","address2":"781 Lupe Lodge","address3":"Shores","address4":"911 Cedrick Harbors\nTellyfort, VA 57572-0466","postalCode":"40141-0680","town":"Barrowsstad","countryId":280,"stateId":null,"checkedAt":"1970-01-17T22:04:49+01:00","title":"","contactPerson":"","taxIdNumber":"","options":[]},{"gender":"male","name1":"Ullrich Ltd","name2":"Tyson","name3":"Shanahan","name4":"mayert.lacey","address1":"Jaqueline Flats","address2":"51555 Bogan Trail Suite 708","address3":"Rapids","address4":"40120 Michael Locks Suite 049\nPort Keanu, CO 51944","postalCode":"32865","town":"Conniemouth","countryId":11,"stateId":null,"checkedAt":"1998-09-20T13:34:10+02:00","title":"","contactPerson":"","taxIdNumber":"","options":[]}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"updatedTo","type":"string","required":false,"description":"Filter that restricts the search result to addresses that were updated before a specific date. Possible formats: yyyy-mm-dd, mm\/dd\/yyyy.","format":"string","in":"query"},{"name":"updatedFrom","type":"string","required":false,"description":"Filter that restricts the search result to addresses that were updated after a specific date. Possible formats: yyyy-mm-dd, mm\/dd\/yyyy.","format":"string","in":"query"},{"name":"createdTo","type":"string","required":false,"description":"Filter that restricts the search result to addresses that were created before a specific date. Possible formats: yyyy-mm-dd, mm\/dd\/yyyy.","format":"string","in":"query"},{"name":"createdFrom","type":"string","required":false,"description":"Filter that restricts the search result to addresses that were created after a specific date. Possible formats: yyyy-mm-dd, mm\/dd\/yyyy.","format":"string","in":"query"},{"name":"with","type":"string","required":false,"description":"Includes the specified address information in the results. The following parameters are available: contactRelations, orderRelations. More than one parameter should be separated by commas.","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 address","description":"Creates an address.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Address"},"examples":{"application\/json":{"gender":"diverse","name1":"Wyman-O'Conner","name2":"Fae","name3":"D'Amore","name4":"ilene17","address1":"Schuppe Mountains","address2":"8116 Abdul Summit Apt. 579","address3":"Square","address4":"485 Homenick Track Suite 054\nPort Justonview, IA 49411-1062","postalCode":"05149","town":"South Madgeton","countryId":238,"stateId":null,"checkedAt":"2015-08-18T08:03:55+02:00","title":"","contactPerson":"","taxIdNumber":"","options":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/accounts\/addresses","schema":{"type":"object","properties":{"gender":{"type":"string","description":"The gender (\"female\", \"male\" or \"diverse\") optional allowed values are male, female, diverse, notToSay"},"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 optional"},"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 optional"},"options":{"type":"array","items":{"$ref":"#\/definitions\/Collection"}}}}}]}},"\/rest\/accounts\/addresses\/contact_relations":{"get":{"summary":"List address contact relations","description":"Lists the address contact relations.","tags":["Account"],"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 AddressContactRelation","items":{"$ref":"#\/definitions\/AddressContactRelation"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"contactId":5516,"typeId":1,"addressId":72661,"isPrimary":false},{"contactId":88338,"typeId":1,"addressId":28166,"isPrimary":false}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 address contact relations with a specific ID","format":"integer","in":"query"},{"name":"contactId","type":"integer","required":false,"description":"Filter that restricts the search result to contacts with a specific ID","format":"integer","in":"query"},{"name":"typeId","type":"integer","required":false,"description":"Filter that restricts the search result to address types with a specific ID","format":"integer","in":"query"},{"name":"addressId","type":"integer","required":false,"description":"Filter that restricts the search result to addresses with a specific ID","format":"integer","in":"query"},{"name":"isPrimary","type":"boolean","required":false,"description":"Filter that restricts the search result depending on the flag used. If the flag isPrimary=true is set, the filter restricts the search result to addresses that are primary addresses. If the flag isPrimary=false is set, the filter restricts the search results to addresses that are not primary addresses. If no flag is set, both primary and non-primary addresses are listed.","format":"boolean","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":"string","required":false,"description":"Includes the specified address contact relation information in the results. The following parameters are available: contact and address. More than one parameter should be separated by commas.","format":"string","in":"query"}]},"post":{"summary":"Create address contact relations","description":"Creates an address contact relation.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/AddressContactRelation"}},"examples":{"application\/json":[{"contactId":52396,"typeId":2,"addressId":67014,"isPrimary":false},{"contactId":30059,"typeId":1,"addressId":43150,"isPrimary":false}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"body","type":"array","required":true,"description":"[<br> {<br> \"isPrimary\": <font color=\"#fcc28c\">true<\/font>,<br> \"contactId\": <font color=\"#d36363\">0<\/font>,<br> \"addressId\": <font color=\"#d36363\">0<\/font>,<br> \"typeId\": <font color=\"#d36363\">1<\/font><br> }<br>]","format":"","in":"query","items":{"type":"string"}}]},"put":{"summary":"Update address contact relations","description":"Updates an address contact relation.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/AddressContactRelation"}},"examples":{"application\/json":[{"contactId":80841,"typeId":2,"addressId":30755,"isPrimary":false},{"contactId":80449,"typeId":2,"addressId":74817,"isPrimary":false}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"body","type":"array","required":true,"description":"[<br> {<br> \"isPrimary\": <font color=\"#fcc28c\">true<\/font>,<br> \"id\": <font color=\"#d36363\">0<\/font>,<br> \"contactId\": <font color=\"#d36363\">0<\/font>,<br> \"addressId\": <font color=\"#d36363\">0<\/font>,<br> \"typeId\": <font color=\"#d36363\">1<\/font><br> }<br>]","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/accounts\/addresses\/contact_relations\/{addressContactRelationId}":{"delete":{"summary":"Delete address contact relation","description":"Deletes an address contact relation. The ID of the address contact relation must be specified.","tags":["Account"],"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":"addressContactRelationId","type":"integer","required":true,"description":"The ID of the address contact relation","format":"integer","in":"path"}]},"get":{"summary":"Get address contact relation","description":"Gets an address contact relation. The ID of the address contact relation must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AddressContactRelation"},"examples":{"application\/json":{"contactId":21919,"typeId":1,"addressId":90329,"isPrimary":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"addressContactRelationId","type":"integer","required":true,"description":"The ID of the address contact relation","format":"integer","in":"path"}]}},"\/rest\/accounts\/addresses\/option_types":{"get":{"summary":"List address option types","description":"Lists the address option types.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/AddressOptionType"}},"examples":{"application\/json":[{"nonErasable":0,"position":15},{"nonErasable":0,"position":11}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 address option type","description":"Creates an address option type.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AddressOptionType"},"examples":{"application\/json":{"nonErasable":0,"position":10}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/accounts\/addresses\/option_types","schema":{"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\n1 = VAT number\n2 = External address ID\n3 = Entry certificate\n4 = Telephone\n5 = Email\n6 = Post number\n7 = Personal id\n8 = BBFC (age rating)\n9 = Birthday\n10 = Session ID\n11 = Title\n12 = Contact person\n13 = External customer ID\n optional"},"names":{"type":"array","items":{"$ref":"#\/definitions\/Collection"}}}}}]}},"\/rest\/accounts\/addresses\/option_types\/{optionTypeId}":{"delete":{"summary":"Delete address option type","description":"Deletes an address option type. The ID of the option type must be specified.","tags":["Account"],"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":"optionTypeId","type":"integer","required":true,"description":"The ID of the address option type","format":"integer","in":"path"}]},"get":{"summary":"Get address option type","description":"Gets an address option type. The ID of the address option type must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AddressOptionType"},"examples":{"application\/json":{"nonErasable":0,"position":14}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionTypeId","type":"integer","required":true,"description":"The ID of the address option type","format":"integer","in":"path"}]},"put":{"summary":"Update address option type","description":"Updates an address option type. The ID of the option type must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AddressOptionType"},"examples":{"application\/json":{"nonErasable":0,"position":14}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionTypeId","type":"integer","required":true,"description":"The ID of the address option type","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/addresses\/option_types\/{optionTypeId}","schema":{"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\n1 = VAT number\n2 = External address ID\n3 = Entry certificate\n4 = Telephone\n5 = Email\n6 = Post number\n7 = Personal id\n8 = BBFC (age rating)\n9 = Birthday\n10 = Session ID\n11 = Title\n12 = Contact person\n13 = External customer ID\n optional"},"names":{"type":"array","items":{"$ref":"#\/definitions\/Collection"}}}}}]}},"\/rest\/accounts\/addresses\/options\/{optionId}":{"delete":{"summary":"Delete address option by option ID","description":"Deletes an address option. The ID of the option must be specified.","tags":["Account"],"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":"optionId","type":"integer","required":true,"description":"The ID of the address option","format":"integer","in":"path"}]},"get":{"summary":"Get address option","description":"Gets an address option. The ID of the option must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AddressOption"},"examples":{"application\/json":{"typeId":1,"value":"anastacio27@hotmail.com","position":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionId","type":"integer","required":true,"description":"The ID of the address option","format":"integer","in":"path"}]},"put":{"summary":"Update address option","description":"Updates an address option. The ID of the option must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AddressOption"},"examples":{"application\/json":{"typeId":1,"value":"hbeer@okeefe.com","position":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionId","type":"integer","required":true,"description":"The ID of the address option","format":"integer","in":"path"}]}},"\/rest\/accounts\/addresses\/pos_relations":{"get":{"summary":"List address POS relations","description":"Lists the address POS relations.","tags":["Account"],"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 AddressPosRelation","items":{"$ref":"#\/definitions\/AddressPosRelation"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"posBaseId":8729977,"typeId":4,"addressId":9849745},{"posBaseId":9686691,"typeId":7,"addressId":7245182}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"page","format":"integer","in":"query"},{"name":"itemsPerPage","type":"integer","required":false,"description":"items per page","format":"integer","in":"query"},{"name":"with","type":"string","required":false,"description":"Includes the specified address pos relation information in the results. The following parameters are available: address and type. More than one parameter should be separated by commas.","format":"string","in":"query"}]},"post":{"summary":"Create address POS relation","description":"Creates an address POS relation.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AddressPosRelation"},"examples":{"application\/json":{"posBaseId":5335937,"typeId":2,"addressId":2068234}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/accounts\/addresses\/pos_relations","schema":{"type":"object","properties":{"posBaseId":{"type":"string","description":"The ID of the POS base"},"typeId":{"type":"integer","description":"The ID of the relation type"},"addressId":{"type":"string","description":"The ID of the address"}}}}]}},"\/rest\/accounts\/addresses\/pos_relations\/{addressPosRelationId}":{"delete":{"summary":"Delete address POS relation","description":"Deletes an address POS relation. The ID of the address POS relation must be specified.","tags":["Account"],"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":"addressPosRelationId","type":"integer","required":true,"description":"The ID of the address POS relation","format":"integer","in":"path"}]},"get":{"summary":"Get address POS relation","description":"Gets an address POS relation. The ID of the address POS relation must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AddressPosRelation"},"examples":{"application\/json":{"posBaseId":9290628,"typeId":3,"addressId":3149096}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"addressPosRelationId","type":"integer","required":true,"description":"The ID of the address POS relation","format":"integer","in":"path"}]},"put":{"summary":"Update address POS relation","description":"Updates an address POS relation. The ID of the address POS relation must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AddressPosRelation"},"examples":{"application\/json":{"posBaseId":9718394,"typeId":8,"addressId":2190175}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"addressPosRelationId","type":"integer","required":true,"description":"The ID of the address POS relation","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/addresses\/pos_relations\/{addressPosRelationId}","schema":{"type":"object","properties":{"posBaseId":{"type":"string","description":"The ID of the POS base"},"typeId":{"type":"integer","description":"The ID of the relation type"},"addressId":{"type":"string","description":"The ID of the address"}}}}]}},"\/rest\/accounts\/addresses\/relation_types":{"get":{"summary":"List address relation types","description":"Lists the address relation types.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/AddressRelationType"}},"examples":{"application\/json":[{"nonErasable":0,"position":10},{"nonErasable":0,"position":14}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/accounts\/addresses\/relations\/types\/applications\/{application}\/{lang}":{"get":{"summary":"List address relation types","description":"Lists address relation types. The application and the language must be specified.\n\n<br>Possible applications:\n<ul>\n<li>contact<\/li>\n<li>order<\/li>\n<li>warehouse<\/li>\n<li>pos<\/li>\n<\/ul>","tags":["Account"],"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":"application","type":"string","required":true,"description":"The application type","format":"string","in":"path"},{"name":"lang","type":"string","required":true,"description":"The language as ISO 639-1 code (e.g. `en` for English)","format":"string","in":"path"}]}},"\/rest\/accounts\/addresses\/warehouse_relations":{"post":{"summary":"Create address warehouse relation","description":"Creates an address warehouse relation.","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\/accounts\/addresses\/warehouse_relations\/{relationId}":{"delete":{"summary":"Delete address warehouse relation","description":"Deletes an address warehouse relation. The ID of the relation must be specified.","tags":["Account"],"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 address warehouse relation","format":"integer","in":"path"}]},"put":{"summary":"Update address warehouse relation","description":"Updates an address warehouse relation. The ID of the relation must be specified.","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."}},"parameters":[{"name":"relationId","type":"integer","required":true,"description":"The ID of the address warehouse relation","format":"integer","in":"path"}]}},"\/rest\/accounts\/addresses\/{addressId}":{"delete":{"summary":"Delete address","description":"Deletes an address. The ID of the address must be specified.","tags":["Account"],"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":"addressId","type":"integer","required":true,"description":"The ID of the address","format":"integer","in":"path"}]},"get":{"summary":"Get address","description":"Gets an address. The ID of the address must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Address"},"examples":{"application\/json":{"gender":"diverse","name1":"Jakubowski Ltd","name2":"Vergie","name3":"Torp","name4":"abshire.romaine","address1":"Labadie Dam","address2":"2026 Skiles Avenue","address3":"Roads","address4":"18169 Dibbert Island Suite 717\nFabiolamouth, WY 79083","postalCode":"25449-5947","town":"Odellview","countryId":117,"stateId":null,"checkedAt":"2022-03-05T08:28:01+01:00","title":"","contactPerson":"","taxIdNumber":"","options":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"addressId","type":"integer","required":true,"description":"The ID of the address","format":"integer","in":"path"},{"name":"with","type":"string","required":false,"description":"Includes the specified address information in the results. The following parameters are available: <code>options<\/code>, <code>contactRelations<\/code>, <code>orderRelations<\/code>, <code>warehouseRelations<\/code>, <code>schedulerRelations<\/code>, <code>reorderRelations<\/code>. More than one parameter should be separated by commas","format":"string","in":"query"}]},"put":{"summary":"Update address","description":"Updates an address. The ID of the address must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Address"},"examples":{"application\/json":{"gender":"female","name1":"Lakin, Mills and Veum","name2":"Hosea","name3":"Reinger","name4":"qbosco","address1":"Mitchell Tunnel","address2":"70950 Thea Village Suite 565","address3":"Garden","address4":"848 Lorenz Avenue\nPort Elenora, TX 61965-9846","postalCode":"96693-1635","town":"Lake Dewayne","countryId":243,"stateId":null,"checkedAt":"1972-10-21T05:34:33+01:00","title":"","contactPerson":"","taxIdNumber":"","options":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"addressId","type":"integer","required":true,"description":"The ID of the address","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/addresses\/{addressId}","schema":{"type":"object","properties":{"gender":{"type":"string","description":"The gender (\"female\", \"male\" or \"diverse\") optional allowed values are male, female, diverse, notToSay"},"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 optional"},"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 optional"},"options":{"type":"array","items":{"$ref":"#\/definitions\/Collection"}}}}}]}},"\/rest\/accounts\/addresses\/{addressId}\/options":{"delete":{"summary":"Delete address option by addressId","description":"Deletes an address option. The ID of the address must be specified.","tags":["Account"],"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":"addressId","type":"integer","required":true,"description":"The ID of the address","format":"integer","in":"path"}]},"get":{"summary":"List address options","description":"Lists address options. The ID of the address must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/AddressOption"}},"examples":{"application\/json":[{"typeId":1,"value":"elton05@fadel.com","position":1},{"typeId":1,"value":"quitzon.willard@gmail.com","position":1}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"addressId","type":"integer","required":true,"description":"The ID of the address","format":"integer","in":"path"}]},"post":{"summary":"Create address option","description":"Creates an address option. The ID of the address must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/AddressOption"}},"examples":{"application\/json":[{"typeId":1,"value":"nolan.hazel@gmail.com","position":1},{"typeId":1,"value":"douglas.bessie@gmail.com","position":1}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"addressId","type":"integer","required":true,"description":"The ID of the address","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/addresses\/{addressId}\/options","schema":{"type":"object","properties":{"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 optional"}}}}]},"put":{"summary":"Update address option by addressId","description":"Updates an address option. The ID of the address must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/AddressOption"}},"examples":{"application\/json":[{"typeId":1,"value":"mitchel40@hotmail.com","position":1},{"typeId":1,"value":"clay.schowalter@fay.com","position":1}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"addressId","type":"integer","required":true,"description":"The ID of the address","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/addresses\/{addressId}\/options","schema":{"type":"object","properties":{"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 optional"}}}}]}},"\/rest\/accounts\/addresses\/{addressId}\/related_data":{"get":{"summary":"Get address data by addressId","description":"Gets the address data by the address ID. The ID of the address must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Address"},"examples":{"application\/json":{"gender":"diverse","name1":"Nader, Stokes and Hartmann","name2":"Clifford","name3":"Stoltenberg","name4":"kelley11","address1":"Casper Manor","address2":"568 Niko Street Suite 036","address3":"Expressway","address4":"34546 Considine Stravenue\nWest Eileen, RI 20477","postalCode":"64041","town":"Volkmanhaven","countryId":13,"stateId":null,"checkedAt":"1984-05-03T23:58:53+02:00","title":"","contactPerson":"","taxIdNumber":"","options":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"addressId","type":"integer","required":true,"description":"The ID of the address","format":"integer","in":"path"},{"name":"orderIds","type":"string","required":false,"description":"The ID of the orders","format":"string","in":"query"}]}},"\/rest\/accounts\/batchDelete":{"delete":{"summary":"Delete Batch of Companies","description":"Deletes multiple companies based on their IDs. The IDs of the companies must be specified.","tags":["Account"],"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\/accounts\/contact_relations":{"post":{"summary":"Create company contact relation","description":"Create a company contact relation. The ID of the account contact relation must be specified.\nAn account is equivalent to a company.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AccountContactRelation"},"examples":{"application\/json":{"contactId":67851,"accountId":29535}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"accountId","type":"integer","required":true,"description":"The ID of the company. An account is equivalent to a company.","format":"integer","in":"query"},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact.","format":"integer","in":"query"}]}},"\/rest\/accounts\/contact_relations\/{accountContactRelationId}":{"delete":{"summary":"Delete company contact relation","description":"Deletes a company contact relation. The ID of the account contact relation must be specified.\nAn account is equivalent to a company.","tags":["Account"],"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":"accountContactRelationId","type":"integer","required":true,"description":"The ID of the company contact relation","format":"integer","in":"path"}]},"get":{"summary":"Get company contact relation","description":"Gets a company contact relation. The ID of the account contact relation must be specified.\nAn account is equivalent to a company.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AccountContactRelation"},"examples":{"application\/json":{"contactId":41560,"accountId":9220}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"accountContactRelationId","type":"integer","required":true,"description":"The ID of the company contact relation","format":"integer","in":"path"}]}},"\/rest\/accounts\/contact_relations\/{accountContactRelationId}\/primary":{"put":{"summary":"Updates an account contact relation isPrimary field","description":"Update an account contact relation isPrimary field. The ID of the account contact relation must be specified.\nAn account is equivalent to a company.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AccountContactRelation"},"examples":{"application\/json":{"contactId":55917,"accountId":76518}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"accountContactRelationId","type":"integer","required":true,"description":"The ID of the company contact relation","format":"integer","in":"path"},{"name":"isPrimary","type":"boolean","required":true,"description":"Sets one contact per account as the primary contact.","format":"boolean","in":"query"}]}},"\/rest\/accounts\/contacts":{"get":{"summary":"List contacts","description":"Lists all contacts.","tags":["Account"],"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 Contact","items":{"$ref":"#\/definitions\/Contact"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"externalId":"338f1d923964dad01427a1ad22dfd362d8df7bdf561979c31a8d9fe3e0ce3f08","number":"842c069a43b987fff2b519d223a57ec1c335f7b2f526f6102ea8517fdbc2ab0f","typeId":7,"firstName":"Kristy","lastName":"Fadel","gender":"male","title":"Mrs.","formOfAddress":"numquam","newsletterAllowanceAt":null,"classId":8,"blocked":0,"bookAccount":1,"lang":"it","referrerId":4.08,"birthdayAt":null,"lastLoginAt":"2013-06-03T21:03:42+02:00","lastOrderAt":null,"plentyId":65411,"email":"","ebayName":"","privatePhone":"","privateFax":"","privateMobile":"","paypalEmail":"","paypalPayerId":"","klarnaPersonalId":"","dhlPostIdent":"","singleAccess":"","contactPerson":"","marketplacePartner":"","fullName":"Kristy Fadel","inLeadStatusSince":0,"options":[]},{"externalId":"5af295496e144c1375df01c958de0e678a3b6a4ac56c7abadfbdfed0f359803b","number":"73038f3c732123813ea07302b20467a541eca4fef4a19cedb0977364f2d6f6f2","typeId":7,"firstName":"Elisa","lastName":"Trantow","gender":"female","title":"Prof.","formOfAddress":"ratione","newsletterAllowanceAt":"2020-12-29T21:02:53+01:00","classId":8,"blocked":0,"bookAccount":8,"lang":"kl","referrerId":170.05,"birthdayAt":null,"lastLoginAt":"1998-06-04T08:02:31+02:00","lastOrderAt":null,"plentyId":65411,"email":"","ebayName":"","privatePhone":"","privateFax":"","privateMobile":"","paypalEmail":"","paypalPayerId":"","klarnaPersonalId":"","dhlPostIdent":"","singleAccess":"","contactPerson":"","marketplacePartner":"","fullName":"Elisa Trantow","inLeadStatusSince":0,"options":[]}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"fullText","type":"string","required":false,"description":"Filter for a fulltext search","format":"string","in":"query"},{"name":"contactEmail","type":"string","required":false,"description":"Filter that restricts\n * the search result to contacts resembling to the given email address","format":"string","in":"query"},{"name":"email","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts with a specific email address","format":"string","in":"query"},{"name":"postalCode","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts with a specific postcode","format":"string","in":"query"},{"name":"plentyId","type":"integer","required":false,"description":"Filter that restricts the\n * search result to contacts with a specific plentyId","format":"integer","in":"query"},{"name":"externalId","type":"integer","required":false,"description":"Filter that restricts the\n * search result to contacts with a specific externalId","format":"integer","in":"query"},{"name":"number","type":"integer","required":false,"description":"Filter that restricts the\n * search result to contacts with a specific number","format":"integer","in":"query"},{"name":"typeId","type":"integer","required":false,"description":"Filter that restricts the\n * search result to contacts with a specific contact type","format":"integer","in":"query"},{"name":"rating","type":"integer","required":false,"description":"Filter that restricts the\n * search result to contacts with a specific rating","format":"integer","in":"query"},{"name":"createdAtBefore","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts that were created before a specific date.\n * Possible formats: yyyy-mm-dd, mm\/dd\/yyyy.","format":"string","in":"query"},{"name":"createdAtAfter","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts that were created after a specific date.\n * Possible formats: yyyy-mm-dd, mm\/dd\/yyyy.","format":"string","in":"query"},{"name":"updatedAtBefore","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts that were updated before a specific date.\n * Possible formats: yyyy-mm-dd, mm\/dd\/yyyy.","format":"string","in":"query"},{"name":"updatedAtAfter","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts that were updated after a specific date.\n * Possible formats: yyyy-mm-dd, mm\/dd\/yyyy.","format":"string","in":"query"},{"name":"lastOrderAtBefore","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts whose last order was created before a specific date.\n * Possible formats: yyyy-mm-dd, mm\/dd\/yyyy.","format":"string","in":"query"},{"name":"lastOrderAtAfter","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts whose last order was created after a specific date.\n * Possible formats: yyyy-mm-dd, mm\/dd\/yyyy.","format":"string","in":"query"},{"name":"with","type":"string","required":false,"description":"Includes the specified contact information in the\n * results. The following parameters are available: addresses, accounts,\n * options, orderSummary, primaryBillingAddress,\n * contactOrders. More than one parameter should be separated by commas.","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":"newsletterAllowanceAfter","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts who registered for the newsletter after a specific date.\n * Possible formats: yyyy-mm-dd, mm\/dd\/yyyy.","format":"string","in":"query"},{"name":"newsletterAllowanceBefore","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts who registered for the newsletter before a specific date.\n * Possible formats: yyyy-mm-dd, mm\/dd\/yyyy.","format":"string","in":"query"},{"name":"newsletterAllowance","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts who registered for the newsletter. Possible values: 'true' and 'false'.\n * True: newsletter registration was successful. False: newsletter registration was not successful.","format":"string","in":"query"},{"name":"contactId","type":"integer","required":false,"description":"Filter that restricts the\n * search result to a specific contact","format":"integer","in":"query"},{"name":"contactAddress","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts with a specific address","format":"string","in":"query"},{"name":"countryId","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts with a specific country","format":"string","in":"query"},{"name":"userId","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts with a specific user","format":"string","in":"query"},{"name":"referrerId","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts with a specific referrer","format":"string","in":"query"},{"name":"name","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts with a specific name","format":"string","in":"query"},{"name":"nameOrId","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts with a specific name or ID.","format":"string","in":"query"},{"name":"town","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts with a specific town","format":"string","in":"query"},{"name":"privatePhone","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts with a private phone number","format":"string","in":"query"},{"name":"billingAddressId","type":"string","required":false,"description":"Filter that restricts the\n * search result to contacts with a billing address with the ID provided","format":"string","in":"query"},{"name":"deliveryAddressId","type":"string","required":false,"description":"Filter that restricts\n * the search result to contacts with a delivery address with the ID provided","format":"string","in":"query"},{"name":"tagIds","type":"array","required":false,"description":"Filter restricts the list of\n * results to contacts with the specified tagIds. More than one ID should be separated by commas.","format":"","in":"query","items":{"type":"integer"}}]},"post":{"summary":"Create contact","description":"Creates a contact.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Contact"},"examples":{"application\/json":{"externalId":"28afebbace4da210caece04d3d56c6ed0bd6dc5163126f9e89b266e4463b202e","number":"1a82d130c3cecd4c1da89ece2ee9eaa1306c6d4fdf20dbec2f9d7d510834cd0a","typeId":4,"firstName":"Rhoda","lastName":"Spinka","gender":"female","title":"Miss","formOfAddress":"cupiditate","newsletterAllowanceAt":"2000-10-23T10:30:01+02:00","classId":5,"blocked":0,"bookAccount":8,"lang":"hi","referrerId":178,"birthdayAt":null,"lastLoginAt":null,"lastOrderAt":null,"plentyId":65411,"email":"","ebayName":"","privatePhone":"","privateFax":"","privateMobile":"","paypalEmail":"","paypalPayerId":"","klarnaPersonalId":"","dhlPostIdent":"","singleAccess":"","contactPerson":"","marketplacePartner":"","fullName":"Rhoda Spinka","inLeadStatusSince":0,"options":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/accounts\/contacts","schema":{"type":"object","properties":{"referrerId":{"type":"number","description":"The origin of the contact"},"typeId":{"type":"integer","description":"The ID of the contact type"},"title":{"type":"string","description":"The title of the contact, e.g. a doctorate optional"},"options":{"type":"array","items":{"$ref":"#\/definitions\/Collection"}}}}}]}},"\/rest\/accounts\/contacts\/banks":{"post":{"summary":"Create bank account","description":"Creates a bank account.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactBank"},"examples":{"application\/json":{"accountOwner":"Fausto O'Keefe","orderId":90,"bankName":"Cory","bankAddress":"6979 Tremblay Mews\nEast Lucioushaven, OH 90596","bankPostalCodeTown":"84715-2896 Keelingtown","bankCountry":"TM","iban":"DE35DE5471984013833393","bic":"PYSEFGNF","lastUpdateBy":"customer","directDebitMandateAvailable":1,"directDebitMandateAt":"2013-11-02 10:50:50","directDebitMethod":"sepaDirectDebit","directDebitType":"first","paymentMethod":"onOff"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/accounts\/contacts\/banks","schema":{"type":"object","properties":{"lastUpdateBy":{"type":"string","description":"The source of the last change (possible values: `customer`, `backend`, `import`) allowed values are customer, backend, import"},"orderId":{"type":"integer","description":"The ID of the order the bank account belongs to optional"},"contactId":{"type":"integer","description":"The ID of the contact the bank account belongs to optional"},"accountNumber":{"type":"string","description":"The account number of the bank account optional"},"sortCode":{"type":"string","description":"The sort code of the bank account optional"},"iban":{"type":"string","description":"The IBAN of the bank account optional"},"accountOwner":{"type":"string","description":"The owner of the bank account"},"directDebitType":{"type":"string","description":"The direct debit type (possible values: `first`, `next`) optional allowed values are first, next"}}}}]}},"\/rest\/accounts\/contacts\/banks\/{contactBankId}":{"delete":{"summary":"Delete bank account","description":"Deletes a bank account. The ID of the bank account must be specified.","tags":["Account"],"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":"contactBankId","type":"integer","required":true,"description":"The ID of the bank account","format":"integer","in":"path"}]},"get":{"summary":"Get bank account","description":"Gets a bank account of the contact. The ID of the bank account must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactBank"},"examples":{"application\/json":{"accountOwner":"Prof. Fidel Heathcote","orderId":319,"bankName":"Alexander","bankAddress":"643 Pinkie Parkways\nLake Wayne, VA 94651","bankPostalCodeTown":"37829 Weimannhaven","bankCountry":"RW","iban":"DE95DE6389934775244515","bic":"PRHPSD5OQN5","lastUpdateBy":"import","directDebitMandateAvailable":1,"directDebitMandateAt":"1989-07-23 13:57:44","directDebitMethod":"sepaDirectDebit","directDebitType":"first","paymentMethod":"onOff"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"contactBankId","type":"integer","required":true,"description":"The ID of the bank account","format":"integer","in":"path"}]},"put":{"summary":"Update bank account","description":"Updates a bank account. The ID of the bank account must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactBank"},"examples":{"application\/json":{"accountOwner":"Favian Tillman","orderId":26,"bankName":"Frank","bankAddress":"26380 Thalia Hills Suite 518\nLake Louisa, OR 67535","bankPostalCodeTown":"19118-2569 Port Vivianne","bankCountry":"AG","iban":"DE85DE0628470012628389","bic":"FVSGQHV9C1U","lastUpdateBy":"backend","directDebitMandateAvailable":0,"directDebitMandateAt":"0000-00-00 00:00:00","directDebitMethod":"sepaDirectDebit","directDebitType":"first","paymentMethod":"recurrent"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"contactBankId","type":"integer","required":true,"description":"The ID of the bank account","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/contacts\/banks\/{contactBankId}","schema":{"type":"object","properties":{"lastUpdateBy":{"type":"string","description":"The source of the last change (possible values: `customer`, `backend`, `import`) allowed values are customer, backend, import"},"orderId":{"type":"integer","description":"The ID of the order the bank account belongs to optional"},"contactId":{"type":"integer","description":"The ID of the contact the bank account belongs to optional"},"accountNumber":{"type":"string","description":"The account number of the bank account optional"},"sortCode":{"type":"string","description":"The sort code of the bank account optional"},"iban":{"type":"string","description":"The IBAN of the bank account optional"},"accountOwner":{"type":"string","description":"The owner of the bank account"},"directDebitType":{"type":"string","description":"The direct debit type (possible values: `first`, `next`) optional allowed values are first, next"}}}}]}},"\/rest\/accounts\/contacts\/batch_update":{"put":{"summary":"Batch Update","description":"Updates a batch of contacts.","tags":["Account"],"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":"tagRelationships","type":"array","required":false,"description":"When this parameter is used, the current relations between contacts and tags\n * will be deleted and replaced by the given ones. If the parameter is not used, the current relations remain.","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/accounts\/contacts\/classes":{"get":{"summary":"List contact classes","description":"Lists the contact classes.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/string"}},"examples":{"application\/json":{"1":"Standard-Endkunde","2":"B2C"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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":"Creates a contact class","description":"Creates a contact class","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactClass"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/accounts\/contacts\/classes\/paginated":{"get":{"summary":"List contact classes paginated","description":"Lists the contact classes paginated","tags":["Account"],"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\/accounts\/contacts\/classes\/{contactClassId}":{"delete":{"summary":"Deletes a contact class","description":"Deletes a contact class","tags":["Account"],"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":"contactClassId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Returns contact class model based on ID","description":"Returns contact class model based on ID","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactClass"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"contactClassId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Updates a contact class","description":"Updates a contact class","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactClass"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"contactClassId","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/contacts\/classes\/{contactClassId}","schema":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the contact class optional"},"name":{"type":"string","description":""},"priceColumn":{"type":"integer","description":""},"showPrice":{"type":"integer","description":"Flag to display price in the online store as Gross(1) or Net(2)"},"discountType":{"type":"integer","description":""},"position":{"type":"integer","description":""},"pqsQuantity1":{"type":"number","description":""},"pqsQuantity2":{"type":"number","description":""},"pqsQuantity3":{"type":"number","description":""},"pqsQuantity4":{"type":"number","description":""},"pqsQuantity5":{"type":"number","description":""},"pqsQuantity6":{"type":"number","description":""},"pqsQuantity7":{"type":"number","description":""},"pqsQuantity8":{"type":"number","description":""},"pqsQuantity9":{"type":"number","description":""},"pqsQuantity10":{"type":"number","description":""},"pnsQuantity1":{"type":"number","description":""},"pnsDiscount1":{"type":"number","description":""},"pnsQuantity2":{"type":"number","description":""},"pnsDiscount2":{"type":"number","description":""},"pnsQuantity3":{"type":"number","description":""},"pnsDiscount3":{"type":"number","description":""},"pnsQuantity4":{"type":"number","description":""},"pnsDiscount4":{"type":"number","description":""},"pnsQuantity5":{"type":"number","description":""},"pnsDiscount5":{"type":"number","description":""},"pmsMop":{"type":"string","description":"optional"},"pmsDiscount":{"type":"number","description":""},"paqsDiscount":{"type":"number","description":""},"payableDueWithin":{"type":"integer","description":""},"minQuantity":{"type":"integer","description":"optional"},"dontUseItemPriceRebates":{"type":"integer","description":""},"customerId":{"type":"integer","description":"optional"},"allowedMops":{"type":"string","description":"The list of allowed payment methods optional"},"pdwQuantity1":{"type":"number","description":""},"pdwDays1":{"type":"integer","description":""},"pdwQuantity2":{"type":"number","description":""},"pdwDays2":{"type":"integer","description":""},"pdwQuantity3":{"type":"number","description":""},"pdwDays3":{"type":"integer","description":""},"pdwQuantity4":{"type":"number","description":""},"pdwDays4":{"type":"integer","description":""},"pdwQuantity5":{"type":"number","description":""},"pdwDays5":{"type":"integer","description":""},"customerGroupsPaymentNotice":{"type":"string","description":"optional"},"earlyPaymentDiscount":{"type":"number","description":"optional"},"earlyPaymentDiscountDays":{"type":"number","description":"optional"},"valuta":{"type":"integer","description":"optional"},"manualDiscount":{"type":"number","description":""}}}}]}},"\/rest\/accounts\/contacts\/classesWithData":{"get":{"summary":"List contact classes","description":"Lists the contact classes.","tags":["Account"],"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\/accounts\/contacts\/contact_events":{"get":{"summary":"List contact events","description":"Lists contact events.","tags":["Account"],"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 ContactEvent","items":{"$ref":"#\/definitions\/ContactEvent"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"contactId":1,"userId":1,"eventDuration":41704,"eventType":"meeting","eventInfo":"The great question certainly.","billable":0,"eventInsertedAt":"2021-01-28T00:00:00+01:00","eventProvisionPaidAt":"2011-01-22T00:00:00+01:00","eventCreditValue":893073.63},{"contactId":1,"userId":1,"eventDuration":54505,"eventType":"meeting","eventInfo":"I eat one of the sort. Next.","billable":1,"eventInsertedAt":"2018-05-31T00:00:00+02:00","eventProvisionPaidAt":"2001-10-21T00:00:00+02:00","eventCreditValue":663804.97}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]},"post":{"summary":"Create contact event","description":"Creates a contact event.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactEvent"},"examples":{"application\/json":{"contactId":1,"userId":1,"eventDuration":21718,"eventType":"meeting","eventInfo":"Lizard in head downwards.","billable":1,"eventInsertedAt":"1985-12-11T00:00:00+01:00","eventProvisionPaidAt":"1991-01-10T00:00:00+01:00","eventCreditValue":449314.3}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},{"in":"body","name":"\/rest\/accounts\/contacts\/contact_events","schema":{"type":"object","properties":{"contactId":{"type":"integer","description":"The ID of the contact this event belongs to"},"userId":{"type":"integer","description":"The ID of the user this event belongs to"},"eventDuration":{"type":"integer","description":"The duration of the event in seconds"},"eventType":{"type":"string","description":"The type of the event. Possible values are call, ticket, email, meeting, webinar, development and design."},"eventInfo":{"type":"string","description":"Informational text about the event optional"}}}}]}},"\/rest\/accounts\/contacts\/contact_events\/types\/preview":{"get":{"summary":"Get contact event types as a key\/value array","description":"Get the contact event types as a key\/value array.","tags":["Account"],"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\/accounts\/contacts\/contact_events\/{contactEventId}":{"delete":{"summary":"Delete contact event","description":"Deletes a contact event. The ID of the contact event must be specified.","tags":["Account"],"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":"contactEventId","type":"integer","required":true,"description":"The ID of the contact event","format":"integer","in":"path"}]},"put":{"summary":"Update contact event","description":"Updates a contact event. The ID of the contact event must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactEvent"},"examples":{"application\/json":{"contactId":1,"userId":1,"eventDuration":29373,"eventType":"meeting","eventInfo":"I should think you can have.","billable":0,"eventInsertedAt":"1985-01-17T00:00:00+01:00","eventProvisionPaidAt":"1989-08-30T00:00:00+02:00","eventCreditValue":200251.3}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"contactEventId","type":"integer","required":true,"description":"The ID of the contact event","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/contacts\/contact_events\/{contactEventId}","schema":{"type":"object","properties":{"contactId":{"type":"integer","description":"The ID of the contact this event belongs to"},"userId":{"type":"integer","description":"The ID of the user this event belongs to"},"eventDuration":{"type":"integer","description":"The duration of the event in seconds"},"eventType":{"type":"string","description":"The type of the event. Possible values are call, ticket, email, meeting, webinar, development and design."},"eventInfo":{"type":"string","description":"Informational text about the event optional"}}}}]}},"\/rest\/accounts\/contacts\/departments":{"get":{"summary":"List contact departments","description":"Lists all contact departments.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/ContactDepartment"}},"examples":{"application\/json":[{"position":31},{"position":33}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 contact department","description":"Creates a contact department.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactDepartment"},"examples":{"application\/json":{"position":10}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/accounts\/contacts\/departments","schema":{"type":"object","properties":{"names":{"type":"array","items":{"$ref":"#\/definitions\/ContactDepartmentName"}},"name":{"type":"string","description":"The name"},"lang":{"type":"string","description":"The language"}}}}]}},"\/rest\/accounts\/contacts\/departments\/{departmentId}":{"delete":{"summary":"Delete contact department","description":"Deletes a contact department. The ID of the department must be specified.","tags":["Account"],"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":"departmentId","type":"integer","required":true,"description":"The ID of the department","format":"integer","in":"path"}]},"get":{"summary":"Get contact department","description":"Gets a contact department. The ID of the department must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactDepartment"},"examples":{"application\/json":{"position":45}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"departmentId","type":"integer","required":true,"description":"The ID of the department","format":"integer","in":"path"}]},"put":{"summary":"Update contact department","description":"Updates a contact department. The ID of the department must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactDepartment"},"examples":{"application\/json":{"position":38}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"departmentId","type":"integer","required":true,"description":"The ID of the department","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/contacts\/departments\/{departmentId}","schema":{"type":"object","properties":{"names":{"type":"array","items":{"$ref":"#\/definitions\/ContactDepartmentName"}},"name":{"type":"string","description":"The name"},"lang":{"type":"string","description":"The language"}}}}]}},"\/rest\/accounts\/contacts\/group_functions":{"get":{"summary":"List all group function related data","description":"Lists all data that is related to the contact group function contents.","tags":["Account"],"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":"Apply selected group function options for given contact IDs","description":"Applies selected group function options for given contact IDs.","tags":["Account"],"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":"contactList","type":"array","required":false,"description":"A list of contact IDs","format":"","in":"query","items":{"type":"string"}},{"name":"emailTemplate","type":"integer","required":false,"description":"An email template ID","format":"integer","in":"query"},{"name":"newsletter","type":"integer","required":false,"description":"A newsletter folder ID","format":"integer","in":"query"},{"name":"addressLabelTemplate","type":"integer","required":false,"description":"An address label template ID","format":"integer","in":"query"}]}},"\/rest\/accounts\/contacts\/option_sub_types":{"get":{"summary":"List contact option sub-types","description":"Lists all contact option sub-types.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/ContactOptionSubType"}},"examples":{"application\/json":[{"nonErasable":0,"position":46},{"nonErasable":0,"position":49}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 contact option sub-type","description":"Creates a contact option sub-type.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactOptionSubType"},"examples":{"application\/json":{"nonErasable":0,"position":26}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/accounts\/contacts\/option_sub_types","schema":{"type":"object","properties":{"names":{"type":"array","items":{"$ref":"#\/definitions\/Collection"}}}}}]}},"\/rest\/accounts\/contacts\/option_sub_types\/{optionSubTypeId}":{"delete":{"summary":"Delete contact option sub-type","description":"Deletes a contact option sub-type. The ID of the contact option sub-type must be specified.","tags":["Account"],"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":"optionSubTypeId","type":"integer","required":true,"description":"The ID of the contact option sub-type","format":"integer","in":"path"}]},"get":{"summary":"Get contact option sub-type","description":"Gets a contact option sub-type. The ID of the contact option sub-type must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactOptionSubType"},"examples":{"application\/json":{"nonErasable":0,"position":27}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionSubTypeId","type":"integer","required":true,"description":"The ID of the contact option sub-type","format":"integer","in":"path"}]},"put":{"summary":"Update contact option sub-type","description":"Updates a contact option sub-type. The ID of the contact option sub-type must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactOptionSubType"},"examples":{"application\/json":{"nonErasable":0,"position":19}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionSubTypeId","type":"integer","required":true,"description":"The ID of the contact option sub-type","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/contacts\/option_sub_types\/{optionSubTypeId}","schema":{"type":"object","properties":{"names":{"type":"array","items":{"$ref":"#\/definitions\/Collection"}}}}}]}},"\/rest\/accounts\/contacts\/option_types":{"get":{"summary":"List contact option types","description":"Lists all contact option types.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/ContactOptionType"}},"examples":{"application\/json":[{"nonErasable":0,"position":15},{"nonErasable":0,"position":22}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"Lists possible option sub-types for each listed option if the parameter 'subTypes' is set.","format":"string","in":"query"}]},"post":{"summary":"Create contact option type","description":"Creates a contact option type.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactOptionType"},"examples":{"application\/json":{"nonErasable":0,"position":16}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/accounts\/contacts\/option_types","schema":{"type":"object","properties":{"names":{"type":"array","items":{"$ref":"#\/definitions\/Collection"}}}}}]}},"\/rest\/accounts\/contacts\/option_types\/{optionTypeId}":{"delete":{"summary":"Delete contact option type","description":"Deletes a contact option type. The ID of the contact option type must be specified.","tags":["Account"],"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":"optionTypeId","type":"integer","required":true,"description":"The ID of the contact option type","format":"integer","in":"path"}]},"get":{"summary":"Get contact option type","description":"Gets a contact option type. The ID of the contact option type must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactOptionType"},"examples":{"application\/json":{"nonErasable":0,"position":17}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionTypeId","type":"integer","required":true,"description":"The ID of the contact option type","format":"integer","in":"path"}]},"put":{"summary":"Update contact option type","description":"Updates a contact option type. The ID of the contact option type must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactOptionType"},"examples":{"application\/json":{"nonErasable":0,"position":37}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionTypeId","type":"integer","required":true,"description":"The ID of the contact option type","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/contacts\/option_types\/{optionTypeId}","schema":{"type":"object","properties":{"names":{"type":"array","items":{"$ref":"#\/definitions\/Collection"}}}}}]}},"\/rest\/accounts\/contacts\/options\/{optionId}":{"delete":{"summary":"Delete contact option","description":"Deletes a contact option. The ID of the option must be specified.","tags":["Account"],"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":"optionId","type":"integer","required":true,"description":"The ID of the option","format":"integer","in":"path"}]},"get":{"summary":"Get contact option","description":"Gets a contact option. The ID of the option must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactOption"},"examples":{"application\/json":{"typeId":6,"subTypeId":1,"value":"Mollitia.","priority":10}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionId","type":"integer","required":true,"description":"The ID of the option","format":"integer","in":"path"}]},"put":{"summary":"Update contact option","description":"Updates a contact option. The ID of the option must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactOption"},"examples":{"application\/json":{"typeId":7,"subTypeId":9,"value":"Inventore.","priority":2}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionId","type":"integer","required":true,"description":"The ID of the option","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/contacts\/options\/{optionId}","schema":{"type":"object","properties":{"typeId":{"type":"integer","description":"The type ID of the contact option.\nIt is possible to define individual contact option types.\nThe following types are available by default and cannot be deleted:\n\n1 = Telephone\n2 = Email\n3 = Telefax\n4 = Web page\n5 = Marketplace\n6 = Identification number\n7 = Payment\n8 = User name\n9 = Group\n10 = Access\n11 = Additional\n13 = Converted by"},"subTypeId":{"type":"integer","description":"The sub-type ID of the contact option.\nIt is possible to define individual contact option sub-types.\nThe following types are available by default and cannot be deleted:\n\n1 = Work\n2 = Mobile private\n3 = Mobile work\n4 = Private\n5 = PayPal\n6 = Ebay\n7 = Amazon\n8 = Klarna\n9 = DHL\n10 = Forum\n11 = Guest\n12 = Contact person\n13 = Marketplace partner\n15 = User"},"value":{"type":"string","description":"The value of the option. Depends on the type\/sub-type."},"priority":{"type":"integer","description":"The priority for sorting"}}}}]}},"\/rest\/accounts\/contacts\/positions":{"get":{"summary":"List contact positions","description":"Lists all contact positions.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/ContactPosition"}},"examples":{"application\/json":[{"position":45},{"position":20}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 contact position","description":"Creates a contact position.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactPosition"},"examples":{"application\/json":{"position":47}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/accounts\/contacts\/positions","schema":{"type":"object","properties":{"names":{"type":"array","items":{"$ref":"#\/definitions\/ContactPositionName"}},"name":{"type":"string","description":"The name"},"lang":{"type":"string","description":"The language"}}}}]}},"\/rest\/accounts\/contacts\/positions\/{positionId}":{"delete":{"summary":"Delete contact position","description":"Deletes a contact position. The ID of the position must be specified.","tags":["Account"],"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":"positionId","type":"integer","required":true,"description":"The ID of the position","format":"integer","in":"path"}]},"get":{"summary":"Get contact position","description":"Gets a contact position. The ID of the position must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactPosition"},"examples":{"application\/json":{"position":29}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"positionId","type":"integer","required":true,"description":"The ID of the position","format":"integer","in":"path"}]},"put":{"summary":"Update contact position","description":"Updates a contact position. The ID of the position must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactPosition"},"examples":{"application\/json":{"position":34}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"positionId","type":"integer","required":true,"description":"The ID of the position","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/contacts\/positions\/{positionId}","schema":{"type":"object","properties":{"names":{"type":"array","items":{"$ref":"#\/definitions\/ContactPositionName"}},"name":{"type":"string","description":"The name"},"lang":{"type":"string","description":"The language"}}}}]}},"\/rest\/accounts\/contacts\/sales_representative_regions":{"get":{"summary":"Get sales representative of region","description":"Gets the a sales representative of the region.","tags":["Account"],"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\/accounts\/contacts\/search":{"post":{"summary":"* Search contacts","description":"Search contacts.","tags":["Account"],"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 Contact","items":{"$ref":"#\/definitions\/Contact"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"externalId":"6dd34ff3aa6a828e17dd92926927d6f7ab124d8ae434e990212ab8c8d2f371e7","number":"b15f31a5544f5955ab5ddff990998464bdc81846b823db69a3ca8d8a69487da7","typeId":3,"firstName":"Andre","lastName":"Koch","gender":"female","title":"Prof.","formOfAddress":"ducimus","newsletterAllowanceAt":"1980-04-20T05:58:39+02:00","classId":5,"blocked":0,"bookAccount":6,"lang":"rn","referrerId":172.07,"birthdayAt":"2018-10-28T00:00:00+02:00","lastLoginAt":"1996-11-13T18:28:42+01:00","lastOrderAt":null,"plentyId":65411,"email":"","ebayName":"","privatePhone":"","privateFax":"","privateMobile":"","paypalEmail":"","paypalPayerId":"","klarnaPersonalId":"","dhlPostIdent":"","singleAccess":"","contactPerson":"","marketplacePartner":"","fullName":"Andre Koch","inLeadStatusSince":0,"options":[]},{"externalId":"daad1e9672db1be2d8e4c7cde4f1aaaf71c4e7d55ebb23ccba0c86dbc01483cc","number":"47c9fa90944d181b9e2ec972bd4d543c02f6a6a795e8656738edfaaf645ef202","typeId":2,"firstName":"Priscilla","lastName":"Quitzon","gender":"diverse","title":"Mr.","formOfAddress":"sint","newsletterAllowanceAt":"2004-06-01T13:37:59+02:00","classId":5,"blocked":0,"bookAccount":2,"lang":"wa","referrerId":172.05,"birthdayAt":null,"lastLoginAt":"1992-12-26T01:32:19+01:00","lastOrderAt":"1981-01-10T05:10:17+01:00","plentyId":65411,"email":"","ebayName":"","privatePhone":"","privateFax":"","privateMobile":"","paypalEmail":"","paypalPayerId":"","klarnaPersonalId":"","dhlPostIdent":"","singleAccess":"","contactPerson":"","marketplacePartner":"","fullName":"Priscilla Quitzon","inLeadStatusSince":0,"options":[]}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 by one or multiple contact ids. <br>Available operators: <font color=\"#f0a3ab\"><strong>eq, neq, in, lte, gte<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"contactId\", \"value\": 10, \"operator\": \"lte\" }]}","format":"integer","in":"query"},{"name":"name","type":"string","required":false,"description":"Filter that restricts the search result to contacts having a name like the provided term. <br>Available operators: <font color=\"#f0a3ab\"><strong>like<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"name\", \"value\": \"John Doe\", \"operator\": \"like\"}]}","format":"string","in":"query"},{"name":"email","type":"string","required":false,"description":"Filter that restricts the search result to contacts having an email address like the provided term. <br>Available operators: <font color=\"#f0a3ab\"><strong>eq, like<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"email\", \"value\": \"support@plentyone.com\", \"operator\": \"eq\"}]}","format":"string","in":"query"},{"name":"phone","type":"integer","required":false,"description":"Filter that restricts the search result to contacts having the phone number like the provided term. <br>Available operators: <font color=\"#f0a3ab\"><strong>eq, like<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"phone\", \"value\": \"+49 1234 123 12 12\", \"operator\": \"like\"}]}","format":"integer","in":"query"},{"name":"address","type":"integer","required":false,"description":"Filter that restricts the search result to contacts having an address like the provided term. <br>Available operators: <font color=\"#f0a3ab\"><strong>like<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"address\", \"value\": \"Lindenstra\u00dfe 33\", \"operator\": \"like\"}]}","format":"integer","in":"query"},{"name":"town","type":"integer","required":false,"description":"Filter that restricts the search result to contacts having the town like the provided term. <br>Available operators: <font color=\"#f0a3ab\"><strong>eq, like<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"town\", \"value\": \"Berlin\", \"operator\": \"eq\"}]}","format":"integer","in":"query"},{"name":"contactData","type":"string","required":false,"description":"Filter that restricts the search result to contacts having several fields like the provided term. <br>Available operators: <font color=\"#f0a3ab\"><strong>like<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"contactData\", \"value\": \"John Doe\", \"operator\": \"like\"}]}","format":"string","in":"query"},{"name":"postcode","type":"string","required":false,"description":"Filter that restricts the search result to contacts having the postcode like the provided term. <br>Available operators: <font color=\"#f0a3ab\"><strong>eq, like<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"postcode\", \"value\": \"123456\", \"operator\": \"like\"}]}","format":"string","in":"query"},{"name":"clientId","type":"integer","required":false,"description":"Filter by one or multiple client ids. <br>Available operators: <font color=\"#f0a3ab\"><strong>eq, in, nin<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"clientId\", \"value\": 1, \"operator\": \"eq\"}]}","format":"integer","in":"query"},{"name":"countryId","type":"integer","required":false,"description":"Filter by one or multiple country ids. <br>Available operators: <font color=\"#f0a3ab\"><strong>eq, in, nin<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"countryId\", \"value\": 1, \"operator\": \"eq\"}]}","format":"integer","in":"query"},{"name":"tagIds","type":"integer","required":false,"description":"Filter by one or multiple tag ids. <br>Available operators: <font color=\"#f0a3ab\"><strong>in, nin<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"tagIds\", \"value\": [1, 2], \"operator\": \"in\"}]}","format":"integer","in":"query"},{"name":"ownerId","type":"integer","required":false,"description":"Filter by one or multiple owner ids. <br>Available operators: <font color=\"#f0a3ab\"><strong>eq, in, nin, null, nn<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"ownerId\", \"value\": 5, \"operator\": \"eq\"}]}","format":"integer","in":"query"},{"name":"typeId","type":"integer","required":false,"description":"Filter by one or multiple type ids. <br>Available operators: <font color=\"#f0a3ab\"><strong>eq, in, nin<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"typeId\", \"value\": [1], \"operator\": \"nin\"}]}","format":"integer","in":"query"},{"name":"rating","type":"integer","required":false,"description":"Filter by one or multiple rating ids. <br>Available operators: <font color=\"#f0a3ab\"><strong>eq, in, nin, null, nn<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"rating\", \"value\": [1], \"operator\": \"in\"}]}","format":"integer","in":"query"},{"name":"classId","type":"integer","required":false,"description":"Filter by one or multiple job class ids. <br>Available operators: <font color=\"#f0a3ab\"><strong>eq, in, nin, null, nn<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"classId\", \"value\": \"-\", \"operator\": \"null\"}]}","format":"integer","in":"query"},{"name":"jobId","type":"integer","required":false,"description":"Filter by one or multiple job position ids. <br>Available operators: <font color=\"#f0a3ab\"><strong>eq, in, nin, null, nn<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"jobId\", \"value\": \"-\", \"operator\": \"nn\"}]}","format":"integer","in":"query"},{"name":"followUp","type":"string","required":false,"description":"Filter by a single date or a range of dates. <br>Available operators: <font color=\"#f0a3ab\"><strong>eq, lte, gte, between<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"followUp\", \"value\": [\"2025-06-04T00:00:00+03:00\", \"2025-06-07T23:59:59+03:00\"], \"operator\": \"between\"}]}","format":"string","in":"query"},{"name":"isGuest","type":"string","required":false,"description":"Filter contacts by type Guest \/ Regular contact. <br>Available operators: <font color=\"#f0a3ab\"><strong>eq<\/strong><\/font>. <br>Example: <br>{\"conditionType\": \"and\", \"fields\": [{\"field\": \"isGuest\", \"value\": true, \"operator\": \"eq\"}]}","format":"string","in":"query"}]}},"\/rest\/accounts\/contacts\/types":{"get":{"summary":"List contact types","description":"Lists all contact types.","tags":["Account"],"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."}}},"post":{"summary":"Create contact type","description":"Creates a contact type.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactType"},"examples":{"application\/json":{"position":9}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/accounts\/contacts\/types","schema":{"type":"object","properties":{"names":{"type":"array","items":{"$ref":"#\/definitions\/Collection"}}}}}]}},"\/rest\/accounts\/contacts\/types\/{typeId}":{"delete":{"summary":"Delete contact type","description":"Deletes a contact type. The ID of the contact type must be specified.","tags":["Account"],"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 contact type","format":"integer","in":"path"}]},"get":{"summary":"Get contact type","description":"Gets a contact type. The ID of the contact type must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactType"},"examples":{"application\/json":{"position":17}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 contact type","format":"integer","in":"path"}]},"put":{"summary":"Update contact type","description":"Updates a contact type. The ID of the contact type must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ContactType"},"examples":{"application\/json":{"position":8}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 contact type","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/contacts\/types\/{typeId}","schema":{"type":"object","properties":{"names":{"type":"array","items":{"$ref":"#\/definitions\/Collection"}}}}}]}},"\/rest\/accounts\/contacts\/{contactId}":{"delete":{"summary":"Delete contact","description":"Deletes a contact. The ID of the contact must be specified.","tags":["Account"],"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":"checkExistingOrders","type":"boolean","required":false,"description":"Flag that checks if the contact is linked to orders.\n * If the contact is linked to orders, CustomerDeleteException is thrown\n * and the contact will not be deleted.","format":"boolean","in":"query"},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]},"get":{"summary":"Get contact","description":"Gets a contact. The ID of the contact must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Contact"},"examples":{"application\/json":{"externalId":"fa5f2f6ef99a7ac37221b100a8e892cc8b7327af4205984ea51a60ad86410bc7","number":"4738120d1f2ae06a2ae046a782e75e7763e98c9704dba37844b64f321bfab992","typeId":2,"firstName":"Ibrahim","lastName":"Powlowski","gender":"male","title":"Prof.","formOfAddress":"non","newsletterAllowanceAt":null,"classId":5,"blocked":0,"bookAccount":7,"lang":"rn","referrerId":178.06,"birthdayAt":"2014-08-22T00:00:00+02:00","lastLoginAt":"1987-11-09T06:08:23+01:00","lastOrderAt":"1999-04-09T18:33:53+02:00","plentyId":65411,"email":"","ebayName":"","privatePhone":"","privateFax":"","privateMobile":"","paypalEmail":"","paypalPayerId":"","klarnaPersonalId":"","dhlPostIdent":"","singleAccess":"","contactPerson":"","marketplacePartner":"","fullName":"Ibrahim Powlowski","inLeadStatusSince":0,"options":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 contact information in the results.\n * The following parameters are available: addresses, accounts.\n * More than one parameter should be separated by commas.","format":"string","in":"query"},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]},"put":{"summary":"Update contact","description":"Updates a contact. The ID of the contact must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Contact"},"examples":{"application\/json":{"externalId":"95bc2c7733b1d57cf53d4ebf856910d26ea6fd3759757156e95e32fee275378c","number":"f2c1b67ce201fcc12a500ee0229b7a113d4e5a2c4f24dad255bab23268915a56","typeId":6,"firstName":"Ilene","lastName":"Herman","gender":"diverse","title":"Ms.","formOfAddress":"laboriosam","newsletterAllowanceAt":null,"classId":5,"blocked":0,"bookAccount":4,"lang":"uz","referrerId":170.01,"birthdayAt":null,"lastLoginAt":null,"lastOrderAt":"2013-07-16T03:08:46+02:00","plentyId":65411,"email":"","ebayName":"","privatePhone":"","privateFax":"","privateMobile":"","paypalEmail":"","paypalPayerId":"","klarnaPersonalId":"","dhlPostIdent":"","singleAccess":"","contactPerson":"","marketplacePartner":"","fullName":"Ilene Herman","inLeadStatusSince":0,"options":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"tagRelationships","type":"array","required":false,"description":"When this parameter is used, the current relations between contacts and tags\n * will be deleted and replaced by the given ones. If the parameter is not used, the current relations remain.","format":"","in":"query","items":{"type":"string"}},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/contacts\/{contactId}","schema":{"type":"object","properties":{"title":{"type":"string","description":"The title of the contact, e.g. a doctorate optional"},"options":{"type":"array","items":{"$ref":"#\/definitions\/Collection"}}}}}]}},"\/rest\/accounts\/contacts\/{contactId}\/access_data\/login_url":{"get":{"summary":"Get login URL","description":"Gets the URL to login as the given contact. The ID of the contact must be specified.","tags":["Account"],"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":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/access_data\/new_password":{"put":{"summary":"Send password link for contact","description":"Sends an email to a contact with a link to change the password. The ID of the contact must be specified.","tags":["Account"],"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":"password","type":"string","required":true,"description":"The new password","format":"string","in":"query"},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/access_data\/set_password":{"put":{"summary":"Update password for contact","description":"Updates the password for a contact. The ID of the contact must be specified.","tags":["Account"],"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":"password","type":"string","required":true,"description":"The new password","format":"string","in":"query"},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/access_data\/unblock_user":{"put":{"summary":"Unblock contact","description":"Unblocks a contact to allow this contact to log in again. The ID of the contact must be specified.","tags":["Account"],"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 contact","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/accounts":{"post":{"summary":"Create company for existing contact","description":"Creates a company for an existing contact. The ID of the company must be specified. An account is equivalent to a company.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Account"},"examples":{"application\/json":{"number":"Nulla nostrum nesciunt qui nam fugit exercitationem. Nam dolores vitae non.","companyName":"Trantow Group LLC","taxIdNumber":"Ut ea saepe et aperiam.","valuta":4540156387,"discountDays":30,"discountPercent":65,"timeForPaymentAllowedDays":129,"userId":7,"createdAt":"2024-07-04T21:32:17+02:00","updatedAt":"2005-12-03T05:59:26+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},{"in":"body","name":"\/rest\/accounts\/contacts\/{contactId}\/accounts","schema":{"type":"object","properties":{"number":{"type":"string","description":"The number of the account optional"},"companyName":{"type":"string","description":"The company name"},"taxIdNumber":{"type":"string","description":"The ID of the tax number optional"},"discountPercent":{"type":"number","description":"The early payment discount in percent specified for the account optional"},"valuta":{"type":"integer","description":"The valuta date in days specified for the account optional"},"discountDays":{"type":"integer","description":"The early payment discount period in days specified for the account optional"},"timeForPaymentAllowedDays":{"type":"integer","description":"The payment due date in days specified for the account optional"},"salesRepresentativeContactId":{"type":"integer","description":"The contact ID of the sales representative optional"},"userId":{"type":"integer","description":"The ID of the account owner optional"},"deliveryTime":{"type":"integer","description":"The delivery time for the supplier optional"},"dealerMinOrderValue":{"type":"number","description":"The minimum order value for the supplier optional"},"supplierCurrency":{"type":"string","description":"The currency used by a supplier optional"},"externalId":{"type":"string","description":"The externalId for this company (like the hubspot company id) optional"}}}}]}},"\/rest\/accounts\/contacts\/{contactId}\/accounts\/{accountId}":{"delete":{"summary":"Delete company of the contact","description":"Deletes a company of the contact. The ID of the contact and the ID of the company must be specified. An account is equivalent to a company.","tags":["Account"],"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":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"},{"name":"accountId","type":"integer","required":true,"description":"The ID of the company","format":"integer","in":"path"}]},"get":{"summary":"Get company of the contact","description":"Gets a company of the contact. The ID of the contact and the ID of the company must be specified. An account is equivalent to a company.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Account"},"examples":{"application\/json":{"number":"Corrupti commodi aut pariatur fugiat. Magni vero qui vel et provident molestiae.","companyName":"Lesch-Braun and Sons","taxIdNumber":"Sit quia qui enim itaque.","valuta":210816072,"discountDays":207,"discountPercent":52,"timeForPaymentAllowedDays":232,"userId":12,"createdAt":"1993-08-01T01:02:12+02:00","updatedAt":"1981-03-19T21:56:32+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"accountId","type":"integer","required":true,"description":"The ID of the company","format":"integer","in":"path"}]},"put":{"summary":"Update company","description":"Updates a company. The ID of the contact and the ID of the company must be specified. An account is equivalent to a company.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Account"},"examples":{"application\/json":{"number":"Consequatur vel veritatis est omnis placeat. Vitae qui modi amet dolore. Molestiae sit et accusamus exercitationem qui ut.","companyName":"Kuhic-Leannon Inc","taxIdNumber":"Consequatur et provident eum.","valuta":7166825570,"discountDays":217,"discountPercent":17,"timeForPaymentAllowedDays":167,"userId":8,"createdAt":"1994-08-07T09:35:21+02:00","updatedAt":"1981-12-06T22:57:39+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"accountId","type":"integer","required":true,"description":"The ID of the account","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/addresses":{"post":{"summary":"Create address for existing contact","description":"Creates an address for a specific contact. The ID of the contact must be specified.\n<br>When creating an address, the system checks for duplicates. If the system finds a duplicate, this address will be assigned to the contact data record.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Address"},"examples":{"application\/json":{"gender":"female","name1":"Harris PLC","name2":"Angus","name3":"Bayer","name4":"ggoldner","address1":"Coby Fall","address2":"792 Myrtice Estate Suite 082","address3":"Highway","address4":"30774 Hudson Isle Suite 243\nAubreybury, OH 84951-4706","postalCode":"06086-3893","town":"Kulaston","countryId":217,"stateId":null,"checkedAt":"2014-09-16T19:46:22+02:00","title":"","contactPerson":"","taxIdNumber":"","options":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"isPrimary","type":"boolean","required":false,"description":"Sets a contact address per address type as the primary address.","format":"boolean","in":"query"},{"name":"typeId","type":"integer","required":false,"description":"The type ID of the address. Possible values: <ul><li>Invoice address = 1<\/li><li> Delivery address = 2<\/li><\/ul>","format":"integer","in":"query"},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/contacts\/{contactId}\/addresses","schema":{"type":"object","properties":{"gender":{"type":"string","description":"The gender (\"female\", \"male\" or \"diverse\") optional allowed values are male, female, diverse, notToSay"},"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 optional"},"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 optional"},"options":{"type":"array","items":{"$ref":"#\/definitions\/Collection"}}}}}]}},"\/rest\/accounts\/contacts\/{contactId}\/addresses\/primary":{"get":{"summary":"Get primary or last created addresses of contact","description":"Gets primary or last created addresses of the contact. The ID of contact must be specified.","tags":["Account"],"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":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/addresses\/{addressId}":{"delete":{"summary":"Delete address of the contact","description":"Deletes an address of the contact. The ID of the contact and the ID of the address must be specified.","tags":["Account"],"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":false,"description":"The type ID of the address. Possible values: <ul><li>Invoice address = 1<\/li><li> Delivery address = 2<\/li><\/ul>","format":"integer","in":"query"},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"},{"name":"addressId","type":"integer","required":true,"description":"The ID of the address","format":"integer","in":"path"}]},"put":{"summary":"Update address of the contact","description":"Updates an address of the contact. The ID of the contact and the ID of the address must be specified.\n<br>When updating an address, the system checks for duplicates if the address has more than one relation. If the system finds a duplicate, this address will be assigned to the contact data record.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Address"},"examples":{"application\/json":{"gender":"diverse","name1":"Reilly Inc","name2":"Malachi","name3":"Lowe","name4":"irippin","address1":"Ellsworth Haven","address2":"42721 Prosacco Roads","address3":"Cove","address4":"8487 Kihn Road\nNorth Katlyn, NV 90940-5864","postalCode":"87002-0363","town":"Port Eunice","countryId":93,"stateId":null,"checkedAt":"2006-06-11T17:00:46+02:00","title":"","contactPerson":"","taxIdNumber":"","options":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"isPrimary","type":"boolean","required":false,"description":"Sets a contact address per address type as the primary address.","format":"boolean","in":"query"},{"name":"typeId","type":"integer","required":false,"description":"The type ID of the address. Possible values: <ul><li>Invoice address = 1<\/li><li> Delivery address = 2<\/li><\/ul>","format":"integer","in":"query"},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"},{"name":"addressId","type":"integer","required":true,"description":"The ID of the address","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/addresses\/{addressId}\/types\/{addressTypeId}\/primary":{"put":{"summary":"Set contact address per address type as primary address","description":"Sets a contact address per address type as the primary address. The ID of the contact, the ID of the address and the ID of the address type must be specified. A primary address can also be defined when you create or update a contact address.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AddressContactRelation"},"examples":{"application\/json":{"contactId":31798,"typeId":1,"addressId":68084,"isPrimary":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"addressId","type":"integer","required":true,"description":"The ID of the address","format":"integer","in":"path"},{"name":"addressTypeId","type":"integer","required":true,"description":"The ID of the address type","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/addresses\/{addressId}\/types\/{addressTypeId}\/reset_primary":{"put":{"summary":"Reset contact primary address","description":"Resets the primary address of the contact. The ID of the contact, the ID of the address and the ID of the address type must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AddressContactRelation"},"examples":{"application\/json":{"contactId":56505,"typeId":2,"addressId":43948,"isPrimary":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"addressId","type":"integer","required":true,"description":"The ID of the address","format":"integer","in":"path"},{"name":"addressTypeId","type":"integer","required":true,"description":"The ID of the address type","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/addresses\/{addressTypeId}":{"get":{"summary":"List addresses that are linked with contacts","description":"Lists addresses of the contact. The ID of the contact must be specified. If you specify page and itemsPerPage, you will get a paginated result. Otherwise you will get an array.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/Address"}},"examples":{"application\/json":[{"gender":"male","name1":"Lakin Inc","name2":"Vladimir","name3":"Koch","name4":"schowalter.otha","address1":"Maud Mountains","address2":"23649 Colten Route Suite 080","address3":"Underpass","address4":"31105 Hane Locks\nSouth Tyriqueton, MO 64661","postalCode":"44780","town":"South Finn","countryId":17,"stateId":null,"checkedAt":"1979-03-14T11:49:12+01:00","title":"","contactPerson":"","taxIdNumber":"","options":[]},{"gender":"diverse","name1":"Dickens LLC","name2":"Theodora","name3":"Gerlach","name4":"acollins","address1":"O'Conner Vista","address2":"733 Juvenal Keys Suite 067","address3":"Prairie","address4":"5287 Robbie Cove\nNew Nakia, KY 65014","postalCode":"02520","town":"South Jonathon","countryId":211,"stateId":null,"checkedAt":"1979-02-27T20:08:06+01:00","title":"","contactPerson":"","taxIdNumber":"","options":[]}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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. The default page that will be returned is page 1.","format":"integer","in":"query"},{"name":"itemsPerPage","type":"integer","required":false,"description":"The number of addresses to list per page. The default number is 1000.","format":"integer","in":"query"},{"name":"contactId","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"name":"addressTypeId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/anonymize":{"put":{"summary":"Anonymize contact","description":"Anonymizes the contact by the given ID.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Contact"},"examples":{"application\/json":{"externalId":"aa822941455487e8f4303d1131c34f9fd204563aa78adafb87806c815b2626f0","number":"c7fa16d23525c6eeb7ca82cb6073d8a35375ed46156b49625336593ced3f7844","typeId":3,"firstName":"Bettye","lastName":"Goodwin","gender":"male","title":"Dr.","formOfAddress":"nesciunt","newsletterAllowanceAt":"2016-02-20T00:24:36+01:00","classId":6,"blocked":0,"bookAccount":7,"lang":"wo","referrerId":0,"birthdayAt":"2001-10-14T00:00:00+02:00","lastLoginAt":null,"lastOrderAt":null,"plentyId":65411,"email":"","ebayName":"","privatePhone":"","privateFax":"","privateMobile":"","paypalEmail":"","paypalPayerId":"","klarnaPersonalId":"","dhlPostIdent":"","singleAccess":"","contactPerson":"","marketplacePartner":"","fullName":"Bettye Goodwin","inLeadStatusSince":0,"options":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/accounts\/contacts\/{contactId}\/banks":{"get":{"summary":"List bank accounts","description":"Lists all bank accounts of the contact. The ID of the contact must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/ContactBank"}},"examples":{"application\/json":[{"accountOwner":"Florence Hermann","orderId":473,"bankName":"Dasia","bankAddress":"76972 Mertz Bypass Apt. 765\nOttisstad, NJ 80465","bankPostalCodeTown":"77721-4352 Claudefurt","bankCountry":"RO","iban":"DE38DE1328106625426906","bic":"QZLNBEQGJOG","lastUpdateBy":"import","directDebitMandateAvailable":1,"directDebitMandateAt":"2019-03-16 12:52:03","directDebitMethod":"sepaB2bDirectDebit","directDebitType":"next","paymentMethod":"recurrent"},{"accountOwner":"Chad O'Connell","orderId":189,"bankName":"Emmy","bankAddress":"57301 Gay Point Suite 356\nPort Wileymouth, MA 92934","bankPostalCodeTown":"95420-3066 West Gabrielle","bankCountry":"MS","iban":"DE41DE7697958225889999","bic":"CPGAEP5O58D","lastUpdateBy":"import","directDebitMandateAvailable":0,"directDebitMandateAt":"0000-00-00 00:00:00","directDebitMethod":"sepaDirectDebit","directDebitType":"next","paymentMethod":"recurrent"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"itemsPerPage","type":"integer","required":false,"description":"The number of items per page","format":"integer","in":"query"}]}},"\/rest\/accounts\/contacts\/{contactId}\/banksPaginated":{"get":{"summary":"List bank accounts paginated","description":"Lists all bank accounts of the contact. The ID of the contact must be specified.","tags":["Account"],"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":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"},{"name":"itemsPerPage","type":"integer","required":false,"description":"The number of items per page","format":"integer","in":"query"}]}},"\/rest\/accounts\/contacts\/{contactId}\/contact_events":{"get":{"summary":"List contact events by contact ID","description":"Lists contact events by the contact ID. The ID of the contact must be specified.","tags":["Account"],"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 ContactEvent","items":{"$ref":"#\/definitions\/ContactEvent"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"contactId":1,"userId":1,"eventDuration":24925,"eventType":"call","eventInfo":"I was sent for.' 'You ought.","billable":0,"eventInsertedAt":"2007-06-01T00:00:00+02:00","eventProvisionPaidAt":"1987-10-01T00:00:00+01:00","eventCreditValue":162783.49},{"contactId":1,"userId":1,"eventDuration":52200,"eventType":"call","eventInfo":"Would not, could not, could.","billable":1,"eventInsertedAt":"2000-06-09T00:00:00+02:00","eventProvisionPaidAt":"2021-05-18T00:00:00+02:00","eventCreditValue":787151.47}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/document":{"get":{"summary":"Get storage object from contact documents","description":"Gets a storage object from contact documents. The ID of the contact must be specified.","tags":["Account"],"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 of the object to get from contact documents.","format":"string","in":"query"},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]},"post":{"summary":"Upload document to contact directory","description":"Uploads a document to the contact directory. The ID of the contact must be specified.","tags":["Account"],"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","format":"string","in":"query"},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/document\/link":{"post":{"summary":"Upload document to contact directory","description":"Uploads a document to the contact directory. The ID of the contact must be specified.","tags":["Account"],"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":"link","type":"string","required":true,"description":"The external link","format":"string","in":"query"},{"name":"title","type":"string","required":false,"description":"An alternative title for the link","format":"string","in":"query"},{"name":"contactId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/document\/link\/{documentId}":{"put":{"summary":"Update an existing document link","description":"Update an existing document link. The ID of the contact must be specified also the document id.","tags":["Account"],"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":"link","type":"string","required":true,"description":"The external link","format":"string","in":"query"},{"name":"title","type":"string","required":false,"description":"An alternative title for the link","format":"string","in":"query"},{"name":"documentId","type":"string","required":true,"description":"The ID of the document link","format":"string","in":"path"},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/document\/url":{"get":{"summary":"Get temporary url for document","description":"Gets a temporary url for a document. The ID of the contact must be specified.","tags":["Account"],"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 to get temporary url for","format":"string","in":"query"},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/documents":{"delete":{"summary":"Delete files from contact documents","description":"Deletes files from contact documents. The ID of the contact must be specified.","tags":["Account"],"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":"array","required":true,"description":"List of storage keys to delete","format":"","in":"query","items":{"type":"string"}},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]},"get":{"summary":"List documents of a contact","description":"Lists all documents that are saved for a contact. The ID of the contact must be specified.","tags":["Account"],"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 from previous request to continue listing documents","format":"string","in":"query"},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/options":{"delete":{"summary":"Delete contact option","description":"Deletes a contact option for an existing contact. The ID of the option must be specified.","tags":["Account"],"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":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]},"get":{"summary":"List contact options","description":"Lists contact options. The ID of the contact must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/ContactOption"}},"examples":{"application\/json":[{"typeId":1,"subTypeId":2,"value":"Ab maxime.","priority":2},{"typeId":1,"subTypeId":5,"value":"Qui et.","priority":2}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"typeId","type":"integer","required":false,"description":"The ID of the type","format":"integer","in":"query"},{"name":"subTypeId","type":"integer","required":false,"description":"The ID of the sub type","format":"integer","in":"query"}]},"post":{"summary":"Create contact option","description":"Creates a contact option for an existing contact. The ID of the contact option must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/ContactOption"}},"examples":{"application\/json":[{"typeId":9,"subTypeId":1,"value":"Dolores.","priority":10},{"typeId":4,"subTypeId":8,"value":"Quasi eos.","priority":7}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]},"put":{"summary":"Update contact option","description":"Updates a contact option for an existing contact. The ID of the contact option must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/ContactOption"}},"examples":{"application\/json":[{"typeId":3,"subTypeId":7,"value":"Qui.","priority":9},{"typeId":1,"subTypeId":10,"value":"Cum non.","priority":5}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/accounts\/contacts\/{contactId}\/options\/validate":{"get":{"summary":"Validate contact option by given value","description":"Validates a contact option by a given value. The ID of the contact must be specified.","tags":["Account"],"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 contact","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/related_data":{"get":{"summary":"List contact related data","description":"Lists all contact related data. The ID of the contact must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Contact"},"examples":{"application\/json":{"externalId":"815e265e58fee4f1f073c96dd6d9caae2b876b74c394e86d758a64e68d0f62f5","number":"218a51b4f2792b5ccde79fa25a4ced13dab1304a3a9663d930d22eab111fb13a","typeId":3,"firstName":"Vilma","lastName":"Bergstrom","gender":"male","title":"Ms.","formOfAddress":"cupiditate","newsletterAllowanceAt":"2016-08-28T07:57:34+02:00","classId":1,"blocked":0,"bookAccount":1,"lang":"nr","referrerId":103,"birthdayAt":"2008-12-11T00:00:00+01:00","lastLoginAt":null,"lastOrderAt":null,"plentyId":65411,"email":"","ebayName":"","privatePhone":"","privateFax":"","privateMobile":"","paypalEmail":"","paypalPayerId":"","klarnaPersonalId":"","dhlPostIdent":"","singleAccess":"","contactPerson":"","marketplacePartner":"","fullName":"Vilma Bergstrom","inLeadStatusSince":0,"options":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/accounts\/contacts\/{contactId}\/sales_representative_regions":{"get":{"summary":"List regions by contactId","description":"Lists the regions. The ID of the contact must be specified.","tags":["Account"],"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":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]}},"\/rest\/accounts\/contacts\/{contactId}\/vcard":{"get":{"summary":"Get vcard filestream of contact","description":"Gets a filestream of the vcard of a contact. The ID of the contact must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/SimpleRestResponse"},"examples":{"application\/json":{"vCardStream":"QkVHSU46VkNBUkQKVkVSU0lPTjozLjAKUFJPRklMRTpWQ0FSRApGTjpKb3NlcGggV2FpdHMKTjpXYWl0cztKb3NlcGg7OzsKQURSO1RZUEU9V09SSyxQUkVGOjs7QsO8cmdlcm1laXN0ZXItQnJ1bm5lci1TdHJhw59lIDE1O0thc3NlbDs7MzQxMTc7RGV1dHNjCiBobGFuZApFTUFJTDtUWVBFPVdPUks6YmlnQHBsZW50eS10ZXN0LmRlCkNBVEVHT1JJRVM6S3VuZGUKTk9URTpJRFw6IDEwMlwsIFR5cFw6IEt1bmRlClBST0RJRDotLy9wbGVudHltYXJrZXRzIEdtYkgvL1ZlcnNpb24gZGV2Ly9ERQpSRVY6MjAyMTA3MjdUMTkzMzUzWgpVSUQ6MTAyCkVORDpWQ0FSRAo="}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/accounts\/guests\/convert":{"post":{"summary":"Convert guest account into regular account","description":"Converts a guest account into a regular account.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Contact"},"examples":{"application\/json":{"externalId":"ba4f8fdb26592cbd290a607aa4be9ffdcab56c8492204f51b953c88a091f8771","number":"e0a9a09fb70130caddfd7e87cd659eabb689ee05e987d23784f835dbda6efdd7","typeId":2,"firstName":"Michele","lastName":"Howell","gender":"male","title":"Mr.","formOfAddress":"quia","newsletterAllowanceAt":"2012-01-22T02:21:13+01:00","classId":3,"blocked":0,"bookAccount":3,"lang":"ny","referrerId":101,"birthdayAt":"1977-06-01T00:00:00+01:00","lastLoginAt":null,"lastOrderAt":"1997-07-22T00:38:21+02:00","plentyId":65411,"email":"","ebayName":"","privatePhone":"","privateFax":"","privateMobile":"","paypalEmail":"","paypalPayerId":"","klarnaPersonalId":"","dhlPostIdent":"","singleAccess":"","contactPerson":"","marketplacePartner":"","fullName":"Michele Howell","inLeadStatusSince":0,"options":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"The ID of the contact","format":"integer","in":"query"}]}},"\/rest\/accounts\/jobs":{"get":{"summary":"Get paginated list of jobs based on provided parameters","description":"Get paginated list of jobs based on provided parameters","tags":["Account"],"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 Job","items":{"$ref":"#\/definitions\/Job"}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 number (defaults to 1).","format":"integer","in":"query"},{"name":"itemsPerPage","type":"integer","required":false,"description":"The number of results per page (defaults to 50).","format":"integer","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"The sorting column (defaults to createdAt).","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"The sorting direction (defaults to desc).","format":"string","in":"query"},{"name":"id","type":"integer","required":false,"description":"Filter results by job id.","format":"integer","in":"query"},{"name":"name","type":"string","required":false,"description":"Filter results by job name.","format":"string","in":"query"},{"name":"with","type":"array","required":false,"description":"Job relations, array or string (comma separated)","format":"","in":"query","items":{"type":"string"}}]},"post":{"summary":"Create a job with given data","description":"Create a job with given data","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Job"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/accounts\/jobs\/{jobId}":{"delete":{"summary":"Delete a job by a given id","description":"Delete a job by a given id. Hard delete, it will be entirely removed.","tags":["Account"],"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":"jobId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get single job by id","description":"Get single job by id","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Job"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"jobId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Update a job names with given data. The id of the job must be specified.","description":"Update a job names with given data. The id of the job must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Job"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"jobId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/accounts\/order_summaries":{"get":{"summary":"List order summaries","description":"Lists order summaries.","tags":["OrderSummary"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/OrderSummary"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 order summary","description":"Creates an order summary.","tags":["OrderSummary"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderSummary"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/accounts\/order_summaries\/contacts\/{contactId}":{"get":{"summary":"Get order summary by contact ID","description":"Gets an order summary. The ID of the contact must be specified.","tags":["OrderSummary"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderSummary"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/accounts\/order_summaries\/orders\/{addressId}":{"get":{"summary":"Get order summary by address ID","description":"Gets an order summary. The ID of the address must be specified.","tags":["OrderSummary"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderSummary"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"addressId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/accounts\/order_summaries\/unpaid":{"get":{"summary":"List unpaid order summaries","description":"Get all unpaid order summaries.","tags":["OrderSummary"],"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 OrderSummary","items":{"$ref":"#\/definitions\/OrderSummary"}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/accounts\/order_summaries\/{orderSummaryId}":{"delete":{"summary":"Delete order summary","description":"Deletes an order summary. The ID of the order summary must be specified.","tags":["OrderSummary"],"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":"orderSummaryId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get order summary by order summary ID","description":"Gets an order summary. The ID of the order summary must be specified.","tags":["OrderSummary"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderSummary"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"orderSummaryId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Update order summary","description":"Updates an order summary. The ID of the order summary must be specified.","tags":["OrderSummary"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderSummary"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"orderSummaryId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/accounts\/sales_representative_regions\/{salesRepresentativeRegionId}":{"delete":{"summary":"Delete region","description":"Deletes a region. The ID of the sales representative`s region must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/SimpleJsonResponse"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"salesRepresentativeRegionId","type":"integer","required":true,"description":"The ID of the account contact relation","format":"integer","in":"path"}]},"get":{"summary":"Get region by ID","description":"Gets the region of the sales representative. The ID of the sales representative`s region must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/SalesRepresentativeRegion"},"examples":{"application\/json":{"countryId":135,"postalCodeArea":"34,35,36,4","accountContactRelationId":850}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"salesRepresentativeRegionId","type":"integer","required":true,"description":"The ID of the account contact relation","format":"integer","in":"path"}]},"put":{"summary":"Update region","description":"Updates the region. The ID of the sales representative`s region must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/SalesRepresentativeRegion"},"examples":{"application\/json":{"countryId":271,"postalCodeArea":"34,35,36,4","accountContactRelationId":389}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"salesRepresentativeRegionId","type":"integer","required":true,"description":"The ID of the account contact relation","format":"integer","in":"path"}]}},"\/rest\/accounts\/{accountId}":{"delete":{"summary":"Delete company","description":"Deletes a company. The ID of the company must be specified. An account is equivalent to a company.","tags":["Account"],"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":"accountId","type":"integer","required":true,"description":"The ID of the company","format":"integer","in":"path"}]},"get":{"summary":"Get company","description":"Gets a company. The ID of the account must be specified. An account is equivalent to a company.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Account"},"examples":{"application\/json":{"number":"Itaque culpa voluptatem ab vero. Enim occaecati dicta libero quaerat nisi soluta. Est et nulla veniam officiis non debitis.","companyName":"Mann and Sons and Sons","taxIdNumber":"Impedit aut commodi ad.","valuta":3662666534,"discountDays":189,"discountPercent":33,"timeForPaymentAllowedDays":169,"userId":1,"createdAt":"1972-12-28T06:43:55+01:00","updatedAt":"2013-02-02T23:08:38+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"accountId","type":"integer","required":true,"description":"The ID of the company","format":"integer","in":"path"}]},"put":{"summary":"Update company","description":"Updates a company. The ID of the company must be specified. An account is equivalent to a company.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Account"},"examples":{"application\/json":{"number":"Sed ab fugiat corporis odit. Et quia non dolor earum non beatae pariatur. Qui cupiditate est vero suscipit ex dicta laborum.","companyName":"Jacobson, Schmeler and Halvorson Ltd","taxIdNumber":"Non ullam magnam delectus.","valuta":5265984160,"discountDays":14,"discountPercent":82,"timeForPaymentAllowedDays":204,"userId":1,"createdAt":"1984-09-26T19:49:25+02:00","updatedAt":"1981-03-10T12:08:07+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"accountId","type":"integer","required":true,"description":"The ID of the company","format":"integer","in":"path"},{"in":"body","name":"\/rest\/accounts\/{accountId}","schema":{"type":"object","properties":{"number":{"type":"string","description":"The number of the account optional"},"companyName":{"type":"string","description":"The company name"},"taxIdNumber":{"type":"string","description":"The ID of the tax number optional"},"discountPercent":{"type":"number","description":"The early payment discount in percent specified for the account optional"},"valuta":{"type":"integer","description":"The valuta date in days specified for the account optional"},"discountDays":{"type":"integer","description":"The early payment discount period in days specified for the account optional"},"timeForPaymentAllowedDays":{"type":"integer","description":"The payment due date in days specified for the account optional"},"salesRepresentativeContactId":{"type":"integer","description":"The contact ID of the sales representative optional"},"userId":{"type":"integer","description":"The ID of the account owner optional"},"deliveryTime":{"type":"integer","description":"The delivery time for the supplier optional"},"dealerMinOrderValue":{"type":"number","description":"The minimum order value for the supplier optional"},"supplierCurrency":{"type":"string","description":"The currency used by a supplier optional"},"externalId":{"type":"string","description":"The externalId for this company (like the hubspot company id) optional"}}}}]}},"\/rest\/accounts\/{accountId}\/contacts":{"get":{"summary":"List contacts","description":"Lists all contacts of the company. The ID of the company must be specified. An account is equivalent to a company","tags":["Account"],"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":"accountId","type":"integer","required":true,"description":"The ID of the company","format":"integer","in":"path"},{"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":"sortBy","type":"string","required":false,"description":"Enables the sort of fields. SortBy has as parameter.\n * The name of the contact field will also be sorted.","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"Enables to sort the result in an ascending and descending order.\n * When you want to sort the results in ascending order, use <code>asc<\/code>.\n * When you want to sort the result in descending order, use <code>desc<\/code>.","format":"string","in":"query"}]}},"\/rest\/accounts\/{accountId}\/contacts\/{contactId}\/sales_representative_regions":{"get":{"summary":"Get region by contactId and accountId","description":"Gets a region. The ID of the contact and the ID of the account must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/SalesRepresentativeRegion"},"examples":{"application\/json":{"countryId":129,"postalCodeArea":"34,35,36,4","accountContactRelationId":822}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"accountId","type":"integer","required":true,"description":"The ID of the account","format":"integer","in":"path"},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]},"post":{"summary":"Create region for sales representative","description":"Creates a region for the sales representative. The ID of the company and the ID of the sales representative (contactId) must be specified. An account is equivalent to a company.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/SalesRepresentativeRegion"},"examples":{"application\/json":{"countryId":191,"postalCodeArea":"34,35,36,4","accountContactRelationId":627}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"accountId","type":"integer","required":true,"description":"The ID of the company","format":"integer","in":"path"},{"name":"contactId","type":"integer","required":true,"description":"The ID of the contact","format":"integer","in":"path"}]}},"\/rest\/address_layout":{"get":{"summary":"List all layouts with their contents","description":"Lists all layouts including the content for each layout.","tags":["AddressDesign"],"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."}}},"post":{"summary":"Create new layout","description":"Creates a new layout with the name and isDefault flag given.","tags":["AddressDesign"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AddressLayout"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"layout","type":"string","required":true,"description":"The layout array","format":"string","in":"query"}]}},"\/rest\/address_layout\/country\/{countryId}":{"get":{"summary":"Get layout by country id","description":"Gets a layout by the country ID. The ID of the country must be specified.","tags":["AddressDesign"],"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":"countryId","type":"integer","required":true,"description":"The ID of the country","format":"integer","in":"path"}]}},"\/rest\/address_layout\/default":{"get":{"summary":"Get default layout","description":"Gets the default layout. If no layout is set as default, the layout with the lowest ID will be returned.","tags":["AddressDesign"],"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\/address_layout\/used_countries\/{uuid}":{"get":{"summary":"List countries used in other layouts","description":"Lists the countries that are already used in other layouts.","tags":["AddressDesign"],"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":"uuid","type":"string","required":true,"description":"The UUID of the current layout","format":"string","in":"path"}]}},"\/rest\/address_layout\/{uuid}":{"delete":{"summary":"Delete layout","description":"Deletes a layout. The ID of the layout must be specified.","tags":["AddressDesign"],"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":"uuid","type":"string","required":true,"description":"The UUID of the layout","format":"string","in":"path"}]},"get":{"summary":"Get layout","description":"Gets a layout. The ID of the layout must be specified.","tags":["AddressDesign"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AddressLayout"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":true,"description":"The UUID of the layout","format":"string","in":"path"}]},"put":{"summary":"Update layout","description":"Updates a layout. The ID of the layout must be specified.","tags":["AddressDesign"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AddressLayout"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"layout","type":"string","required":true,"description":"The layout array","format":"string","in":"query"},{"name":"uuid","type":"string","required":true,"description":"The UUID of the layout","format":"string","in":"path"}]}},"\/rest\/address_layout_fields":{"get":{"summary":"List all available fields","description":"Lists all available fields.","tags":["AddressDesign"],"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\/advance_orders":{"post":{"summary":"Create an advance order","description":"Creates an advance order.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":6,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/advance_orders\/items\/{orderItemId}\/assign_variation":{"post":{"summary":"Change an order item of type \"unassigned variation\" to \"variation\".","description":"Change an order item of type \"unassigned variation\" to \"variation\". The ID of the order item and variation ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":2,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/advance_orders\/items\/{orderItemId}\/unassign_variation":{"post":{"summary":"Change an order item of type \"variation\" to \"unassigned variation\".","description":"Change an order item of type \"variation\" to \"unassigned variation\". The ID of the order item must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":5,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/advance_orders\/preview":{"post":{"summary":"Get an advance order create preview.","description":"Returns an advance order preview for the given order data without creating an advance order.","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\/advance_orders\/{orderId}":{"delete":{"summary":"Delete an advance order","description":"Deletes an advance order. 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 an advance order","description":"Updates an advance order. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":2,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/advance_orders\/{orderId}\/preview":{"put":{"summary":"Get an advance order update preview","description":"Returns an advance order preview for the given order data without updating an advance order. The order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/advance_orders\/{orderId}\/restore":{"post":{"summary":"Restore an advance order","description":"Restores a deleted advance order. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":7,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/audit-log\/archive":{"get":{"summary":"Get available audit log archives.","description":"Get a list of all available audit log entities grouped by a group name","tags":["AuditLog"],"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 Archive","items":{"$ref":"#\/definitions\/Archive"}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/audit-log\/archive\/{key}\/restore":{"post":{"summary":"Restore an audit log archive","description":"Restore an audit log archive and make it downloadable for approximately 2 days","tags":["AuditLog"],"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":"key","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/audit-log\/archive\/{key}\/signed-url":{"get":{"summary":"Get the download url for an restored audit log archive","description":"Get the download url for an restored audit log archive","tags":["AuditLog"],"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":"key","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/audit-log\/entities":{"get":{"summary":"Get available audit log entities.","description":"Get a list of all available audit log entities grouped by a group name","tags":["AuditLog"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/EntityGroup"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/audit-log\/files":{"get":{"summary":"Get available audit log entities.","description":"Get a list of all available audit log entities grouped by a group name","tags":["AuditLog"],"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\/audit-log\/files\/{key}\/signed-url":{"get":{"summary":"Get the download url for an restored audit log file","description":"Get the download url for an restored audit log file","tags":["AuditLog"],"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":"key","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/audit-log\/system-config":{"get":{"summary":"Get audit log system config","description":"Get the current audit log configuration. The system configuration contains the information which entities should be logged and which not.","tags":["AuditLog"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/SystemConfig"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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":"Write the system config","description":"Update the audit log system configuration. The system configuration contains the information which entities should be logged and which not.","tags":["AuditLog"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/SystemConfig"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/authorized_user":{"get":{"summary":"Get authorized user","description":"Gets an authorized user. This call returns a JSON object with information about the user after login.\nThis 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\/availabilities":{"get":{"summary":"List item availabilities","description":"Lists all item availabilities.","tags":["Item"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/Availability"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/availabilities\/{id}":{"get":{"summary":"Get an item availability","description":"Gets an item availability. The ID of the availability must be specified.","tags":["Item"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Availability"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 availability","description":"Updates an item availability.","tags":["Item"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Availability"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/availabilities\/{id}","schema":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of this availability allowed values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10"},"averageDays":{"type":"integer","description":"The average delivery time in days for this availability"},"names":{"type":"array","items":{"$ref":"#\/definitions\/AvailabilityName"}},"name":{"type":"string","description":"The name of the item availability in the specified language optional"},"lang":{"type":"string","description":"The language code of the availability name"}}}}]}},"\/rest\/backend\/user\/{userId}":{"get":{"summary":"Get user by id","description":"Get a user specified by userId.","tags":["User"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/User"},"examples":{"application\/json":{"id":3,"user":"shayna.price_40487","realName":"Emmanuel Tromp III","lang":"mr","ipLimit":"","ustatus":2,"memberId":0,"timestamp":{"date":"1985-03-02 20:27:24.000000","timezone_type":3,"timezone":"Europe\/Berlin"},"email":"prosacco.loyce@hotmail.com","timezone":"Europe\/Berlin","googleEmail":"","skype":"","ical":"","psConfig":0,"psItem":0,"psEbay":0,"psStock":0,"psCustomer":0,"psOrder":0,"psStats":0,"psData":0,"pcConfig":0,"pcContent":0,"pcNewsletter":0,"pcLayout":0,"pcDialog":0,"pcStats":0,"pcData":0,"pcBlog":0,"signature":null,"color":"#000000","eks":1,"payments":1,"acceptAgb":0,"api":0,"image":"","delOrder":0,"delArticle":0,"delRecord":0,"plentystat":0,"plentyconnect":0,"webspaceAccess":0,"accessControlList":"","plentymarketsShippingOrderId":0,"plentymarketsShippingItem":0,"plentymarketsShippingAuto":0,"plentymarketsShippingLabel":0,"plentymarketsShippingConfig":0,"warehouseId":null,"calendar":0,"orderStatus":"","warehouseRepairId":null,"project":0,"ticket":0,"order":0,"blog":0,"lead":0,"customer":0,"totalVacationDays":"0","roleId":null,"salutation":"","dataLang":"de","disabled":0,"scheduler":0,"item":0,"incomingItems":0,"backendPluginSetId":null,"global_roles":"[]"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"userId","type":"integer","required":true,"description":"The UserId","format":"integer","in":"path"}]}},"\/rest\/backend\/users":{"get":{"summary":"Get all users","description":"Get all users in an array.","tags":["User"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/User"}},"examples":{"application\/json":[{"id":3,"user":"joshua.feeney_60800","realName":"Dr. Donna Corwin I","lang":"dv","ipLimit":"","ustatus":2,"memberId":0,"timestamp":{"date":"1995-01-04 13:39:21.000000","timezone_type":3,"timezone":"Europe\/Berlin"},"email":"ejenkins@bradtke.com","timezone":"Europe\/Berlin","googleEmail":"","skype":"","ical":"","psConfig":0,"psItem":0,"psEbay":0,"psStock":0,"psCustomer":0,"psOrder":0,"psStats":0,"psData":0,"pcConfig":0,"pcContent":0,"pcNewsletter":0,"pcLayout":0,"pcDialog":0,"pcStats":0,"pcData":0,"pcBlog":0,"signature":null,"color":"#000000","eks":1,"payments":1,"acceptAgb":0,"api":0,"image":"","delOrder":0,"delArticle":0,"delRecord":0,"plentystat":0,"plentyconnect":0,"webspaceAccess":0,"accessControlList":"","plentymarketsShippingOrderId":0,"plentymarketsShippingItem":0,"plentymarketsShippingAuto":0,"plentymarketsShippingLabel":0,"plentymarketsShippingConfig":0,"warehouseId":null,"calendar":0,"orderStatus":"","warehouseRepairId":null,"project":0,"ticket":0,"order":0,"blog":0,"lead":0,"customer":0,"totalVacationDays":"0","roleId":null,"salutation":"","dataLang":"de","disabled":0,"scheduler":0,"item":0,"incomingItems":0,"backendPluginSetId":null,"global_roles":"[]"},{"id":3,"user":"haag.rachelle_29537","realName":"Johan Fritsch","lang":"be","ipLimit":"","ustatus":2,"memberId":0,"timestamp":{"date":"2005-02-08 18:44:08.000000","timezone_type":3,"timezone":"Europe\/Berlin"},"email":"leannon.jabari@yahoo.com","timezone":"Europe\/Berlin","googleEmail":"","skype":"","ical":"","psConfig":0,"psItem":0,"psEbay":0,"psStock":0,"psCustomer":0,"psOrder":0,"psStats":0,"psData":0,"pcConfig":0,"pcContent":0,"pcNewsletter":0,"pcLayout":0,"pcDialog":0,"pcStats":0,"pcData":0,"pcBlog":0,"signature":null,"color":"#000000","eks":1,"payments":1,"acceptAgb":0,"api":0,"image":"","delOrder":0,"delArticle":0,"delRecord":0,"plentystat":0,"plentyconnect":0,"webspaceAccess":0,"accessControlList":"","plentymarketsShippingOrderId":0,"plentymarketsShippingItem":0,"plentymarketsShippingAuto":0,"plentymarketsShippingLabel":0,"plentymarketsShippingConfig":0,"warehouseId":null,"calendar":0,"orderStatus":"","warehouseRepairId":null,"project":0,"ticket":0,"order":0,"blog":0,"lead":0,"customer":0,"totalVacationDays":"0","roleId":null,"salutation":"","dataLang":"de","disabled":0,"scheduler":0,"item":0,"incomingItems":0,"backendPluginSetId":null,"global_roles":"[]"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/backend\/users\/search_name\/{name}":{"get":{"summary":"Find user by name","description":"Find all users having a name or username like the given one.","tags":["User"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/User"}},"examples":{"application\/json":[{"id":3,"user":"wparisian_4976","realName":"Kamille White MD","lang":"nl","ipLimit":"","ustatus":2,"memberId":0,"timestamp":{"date":"1994-09-26 06:47:54.000000","timezone_type":3,"timezone":"Europe\/Berlin"},"email":"olga20@gmail.com","timezone":"Europe\/Berlin","googleEmail":"","skype":"","ical":"","psConfig":0,"psItem":0,"psEbay":0,"psStock":0,"psCustomer":0,"psOrder":0,"psStats":0,"psData":0,"pcConfig":0,"pcContent":0,"pcNewsletter":0,"pcLayout":0,"pcDialog":0,"pcStats":0,"pcData":0,"pcBlog":0,"signature":null,"color":"#000000","eks":1,"payments":1,"acceptAgb":0,"api":0,"image":"","delOrder":0,"delArticle":0,"delRecord":0,"plentystat":0,"plentyconnect":0,"webspaceAccess":0,"accessControlList":"","plentymarketsShippingOrderId":0,"plentymarketsShippingItem":0,"plentymarketsShippingAuto":0,"plentymarketsShippingLabel":0,"plentymarketsShippingConfig":0,"warehouseId":null,"calendar":0,"orderStatus":"","warehouseRepairId":null,"project":0,"ticket":0,"order":0,"blog":0,"lead":0,"customer":0,"totalVacationDays":"0","roleId":null,"salutation":"","dataLang":"de","disabled":0,"scheduler":0,"item":0,"incomingItems":0,"backendPluginSetId":null,"global_roles":"[]"},{"id":3,"user":"michele52_84655","realName":"Danielle Lang","lang":"id","ipLimit":"","ustatus":2,"memberId":0,"timestamp":{"date":"2003-01-10 21:36:17.000000","timezone_type":3,"timezone":"Europe\/Berlin"},"email":"runolfsdottir.percival@gmail.com","timezone":"Europe\/Berlin","googleEmail":"","skype":"","ical":"","psConfig":0,"psItem":0,"psEbay":0,"psStock":0,"psCustomer":0,"psOrder":0,"psStats":0,"psData":0,"pcConfig":0,"pcContent":0,"pcNewsletter":0,"pcLayout":0,"pcDialog":0,"pcStats":0,"pcData":0,"pcBlog":0,"signature":null,"color":"#000000","eks":1,"payments":1,"acceptAgb":0,"api":0,"image":"","delOrder":0,"delArticle":0,"delRecord":0,"plentystat":0,"plentyconnect":0,"webspaceAccess":0,"accessControlList":"","plentymarketsShippingOrderId":0,"plentymarketsShippingItem":0,"plentymarketsShippingAuto":0,"plentymarketsShippingLabel":0,"plentymarketsShippingConfig":0,"warehouseId":null,"calendar":0,"orderStatus":"","warehouseRepairId":null,"project":0,"ticket":0,"order":0,"blog":0,"lead":0,"customer":0,"totalVacationDays":"0","roleId":null,"salutation":"","dataLang":"de","disabled":0,"scheduler":0,"item":0,"incomingItems":0,"backendPluginSetId":null,"global_roles":"[]"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":true,"description":"The name to search for","format":"string","in":"path"}]}},"\/rest\/basket":{"get":{"summary":"Get basket","description":"Gets the shopping cart for the current customer session.","tags":["Basket"],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Basket"},"examples":{"application\/json":{"sessionId":"97850eb42dc2b421bca8a7bfbe4f7636","orderId":null,"customerId":null,"customerInvoiceAddressId":null,"customerShippingAddressId":null,"currency":"PKR","referrerId":1,"shippingCountryId":301,"methodOfPaymentId":6065,"shippingProviderId":103,"shippingProfileId":19,"itemSum":7724872.9885606,"itemSumNet":3227859.6881972,"basketAmount":91101,"basketAmountNet":522.971076,"shippingAmount":1.837,"shippingAmountNet":171.216,"paymentAmount":9536.6953607,"couponCode":"inventore","couponDiscount":7,"shippingDeleteByCoupon":true,"basketRebate":79.94818455,"basketRebateType":9,"maxFsk":4,"orderTimestamp":1463847902,"createdAt":"2024-04-18T00:00:00+02:00","updatedAt":"2006-07-14T00:00:00+02:00"}}}}}},"\/rest\/basket\/items":{"get":{"summary":"List basket items","description":"Lists all items in the shopping cart for the current customer session.","tags":["Basket"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/BasketItem"}},"examples":{"application\/json":[{"quantity":44,"variationId":99205,"createdAt":"2014-06-15T00:00:00+02:00","updatedAt":"2020-05-03T00:00:00+02:00"},{"quantity":89,"variationId":99206,"createdAt":"2003-05-16T00:00:00+02:00","updatedAt":"2021-08-07T00:00:00+02:00"}]}}}},"post":{"summary":"Add item to basket","description":"Adds a new item to the shopping cart using the request parameters.","tags":["Basket"],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/BasketItem"},"examples":{"application\/json":{"quantity":32,"variationId":99204,"createdAt":"2009-07-17T00:00:00+02:00","updatedAt":"2007-08-05T00:00:00+02:00"}}}},"parameters":[{"in":"body","name":"\/rest\/basket\/items","schema":{"type":"object","properties":{"variationId":{"type":"integer","description":"The ID of the item variation"},"quantity":{"type":"number","description":"The current quantity of the item"},"inputHeight":{"type":"integer","description":"The height of the item optional"},"inputWidth":{"type":"integer","description":"The width of the item optional"},"inputLength":{"type":"integer","description":"The length of the item optional"},"referrerId":{"type":"number","description":"The ID of the order referrer optional"},"deliveryDate":{"type":"string","description":"The delivery date optional"},"giftPackageForRowId":{"type":"integer","description":"optional"},"categoryId":{"type":"integer","description":"The ID of the item category optional"},"noEditByCustomer":{"type":"boolean","description":"Shows whether the item was edited by the customer optional"},"basketItemOrderParams":{"type":"array","items":{}}}}}]}},"\/rest\/basket\/items\/{id}":{"get":{"summary":"Find a basket item by it's ID","description":"Retrieve an item that is currently in the basket by it's ID","tags":["Basket"],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/BasketItem"},"examples":{"application\/json":{"quantity":51,"variationId":99207,"createdAt":"1992-08-08T00:00:00+02:00","updatedAt":"2015-01-16T00:00:00+01:00"}}}},"parameters":[{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/batch":{"get":{"summary":"Make batch requests","description":"Pass up to 20 operations into a single HTTP request.","tags":["Batch"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":[{"resource":"rest\/listings?itemsPerPage=1","method":"GET","content":"{\"page\":1,\"totalsCount\":291,\"isLastPage\":false,\"entries\":[{\"id\":12,\"itemId\":5820078,\"unitCombinationId\":1,\"typeId\":2,\"stockDependenceTypeId\":3}],\"lastPageNumber\":291,\"firstOnPage\":1,\"lastOnPage\":1,\"itemsPerPage\":1}"},{"resource":"rest\/listings","method":"POST","content":"{\"itemId\":123,\"unitCombinationId\":1,\"typeId\":2,\"stockDependenceTypeId\":3}"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/batch","schema":{"type":"object","properties":{"payloads":{"type":"array","items":{"type":"string"}}}}}]}},"\/rest\/bi\/key-figures":{"get":{"summary":"Return list of key figure classes","description":"Return a list of key figure classes with items <caption, value>","tags":["BI"],"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\/bi\/key-figures\/cache":{"post":{"summary":"Checks if results change since provided $since parameter and returns ids of updated key figures","description":"Params $ids array\n $since string|int carbon readable time\n\nResponds 200 with ids of updated key figures or empty array\nResponds 400 if $since date is not parsable by Carbon\n $ids is empty or the values are malformed\nResponds 413 if ids length exceeds 3000 (~105kb sent to database, security measure)\nResponds 500 if scaleBasis could not be parsed\n database error","tags":["BI"],"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":"ids","type":"array","required":true,"description":"Key figure config IDs","format":"","in":"query","items":{"type":"string"}},{"name":"since","type":"string","required":true,"description":"Carbon date since last result generation","format":"string","in":"query"}]}},"\/rest\/bi\/key-figures\/config":{"get":{"summary":"Returns all key figure configs","description":"Returns all key figure configs paginated, by default as 25 per page.\nCan be called with optional param \u2018with\u2019 that loads additional relations for key figure\nas filter, targets, dimensions, dimensionsValues","tags":["BI"],"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 KeyFigureConfig","items":{"$ref":"#\/definitions\/KeyFigureConfig"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"id":"1f351902-18dc-384f-85bd-25340b3bab2f","plentyId":100,"plentyIdHash":"135d3b270746d6c9d50e11253239fcf3","keyFigure":"sales","keyFigureName":"facilis38f86b48610aade6fb4c4cc34665cbe1","filter":{"dimension":"creationDate","calculation":"grossSales"},"targets":[],"meta":{"creatorUserId":3,"creatorRealName":"Test user"},"updatedAt":"2025-08-12T13:41:32+02:00","createdAt":"2025-09-05T06:57:03+02:00"},{"id":"7d83d2f6-b92a-32aa-a7ed-6aa8c90b4fda","plentyId":100,"plentyIdHash":"7b8a378304ab2fee4e3db70c49bc4378","keyFigure":"sales","keyFigureName":"quisquam9a896cf56b2991e0962e9dd890b962d5","filter":{"dimension":"creationDate","calculation":"grossSales"},"targets":[],"meta":{"creatorUserId":3,"creatorRealName":"Test user"},"updatedAt":"2025-09-09T16:29:32+02:00","createdAt":"2025-08-30T15:11:19+02:00"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 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 key figure configurations to be displayed per page. The default number of key figure configurations per page is 25.","format":"integer","in":"query"},{"name":"keyFigure","type":"string","required":false,"description":"Filter that restricts the search result to key figure configurations of a key figure.","format":"string","in":"query"},{"name":"ids","type":"array","required":false,"description":"Optional list of IDs that limit the search query","format":"","in":"query","items":{"type":"string"}},{"name":"with","type":"array","required":false,"description":"Load additional relations for a key figure. The following relations are available:\n * <ul>\n <li>'filter' = Filter options of this key figure.<\/li>\n <li>'targets' = Target values of this key figure.<\/li>\n <li>'dimensions' = Available dimensions of this key figure.<\/li>\n <li>'dimensionValues' = Available dimension values of this key figure.<\/li>\n <\/ul>\n Example: <code>?with[]=dimension&with[]=dimensionValues<\/code>","format":"","in":"query","items":{"type":"string"}}]},"post":{"summary":"Add a key figure configuration","description":"Add key figure configuration with filters, targets, dimensions, dimensionsValues","tags":["BI"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/KeyFigureConfig"},"examples":{"application\/json":{"id":"1d56f0ba-d184-3a64-84ca-98840ec909d0","plentyId":100,"plentyIdHash":"6be3d2cf91f7c43473ef0c0bdb67e15a","keyFigure":"sales","keyFigureName":"similiquef5ca1a7a20723ff2c46de04247cfdc99","filter":{"dimension":"creationDate","calculation":"grossSales"},"targets":[],"meta":{"creatorUserId":3,"creatorRealName":"Test user"},"updatedAt":"2025-08-12T12:44:28+02:00","createdAt":"2025-08-30T03:44:17+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/bi\/key-figures\/config\/template":{"post":{"summary":"Generate key figure config from template class","description":"Based on selected template a key figure configuration is generated","tags":["BI"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/KeyFigureConfig"},"examples":{"application\/json":{"id":"52238cdf-4172-3f27-9ccf-4f6d3110d33f","plentyId":100,"plentyIdHash":"5c9144f91e02aeb6f9e9a8c8fc8d91bc","keyFigure":"sales","keyFigureName":"suntd27e346877aef185b1dbdddc49995bdf","filter":{"dimension":"creationDate","calculation":"grossSales"},"targets":[],"meta":{"creatorUserId":3,"creatorRealName":"Test user"},"updatedAt":"2025-08-11T06:33:25+02:00","createdAt":"2025-08-23T05:10:08+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},{"name":"externalId","type":"string","required":false,"description":"Identifier to assign the result","format":"string","in":"query"}]}},"\/rest\/bi\/key-figures\/config\/templates":{"get":{"summary":"Get key figure templates","description":"Return list of templates available from configurations","tags":["BI"],"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\/bi\/key-figures\/config\/{keyFigureConfigId}":{"delete":{"summary":"Delete key figure configuration","description":"Delete a key figure configuration with a specified configuration id","tags":["BI"],"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":"Get key figure configuration including filters, targets, dimensions, dimensionsValues","tags":["BI"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/KeyFigureConfig"},"examples":{"application\/json":{"id":"9569e0d3-b15b-336e-8578-6f671c48997a","plentyId":100,"plentyIdHash":"fa770ca396361b49a7e1893285f7fd11","keyFigure":"sales","keyFigureName":"ut8cf42fcb0b5a4beee5fcf5d5d66a4eb2","filter":{"dimension":"creationDate","calculation":"grossSales"},"targets":[],"meta":{"creatorUserId":3,"creatorRealName":"Test user"},"updatedAt":"2025-09-04T18:41:39+02:00","createdAt":"2025-08-22T18:16:07+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"Load additional relations for a key figure. The following relations are available:\n * <ul>\n <li>'dimensions' = Available dimensions of this key figure.<\/li>\n <li>'dimensionValues' = Available dimension values of this key figure.<\/li>\n <\/ul>\n Example: <code>?with[]=dimension&with[]=dimensionValues<\/code>","format":"","in":"query","items":{"type":"string"}},{"name":"keyFigureConfigId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Update key figure configuration","description":"Update key figure configuration including filters, targets, dimensions, dimensionsValues","tags":["BI"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/KeyFigureConfig"},"examples":{"application\/json":{"id":"3940c2d5-9222-3726-afe9-e2d801a4fd53","plentyId":100,"plentyIdHash":"2b23eb265b29fe14a80eb620e68c28ed","keyFigure":"sales","keyFigureName":"et7a7470aee4c006cfd3cfe71912d3518f","filter":{"dimension":"creationDate","calculation":"grossSales"},"targets":[],"meta":{"creatorUserId":3,"creatorRealName":"Test user"},"updatedAt":"2025-09-05T13:07:43+02:00","createdAt":"2025-08-14T01:32:13+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/bi\/key-figures\/configs":{"delete":{"summary":"Delete multiple key figure configurations","description":"Delete multiple key figure configurations given on array of configurations ids","tags":["BI"],"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\/bi\/key-figures\/details\/{keyFigureName}":{"get":{"summary":"Return key figure calculation details","description":"return key figure filled with calculation details:\ndimensions, rawDataColumns, filters, aggregate functions","tags":["BI"],"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\/bi\/key-figures\/dimensions\/{keyFigure}":{"get":{"summary":"Return key figure dimensions and dimension values","description":"Returns the list of dimensions and dimensions values for a specific key figure","tags":["BI"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/KeyFigureConfig"},"examples":{"application\/json":{"id":"acebea8e-edda-31b9-8f38-f52d17b4408d","plentyId":100,"plentyIdHash":"0b7ca4f1ce599e19605a56f99a32963f","keyFigure":"sales","keyFigureName":"sed34084153e458c858b935e99427b79829","filter":{"dimension":"creationDate","calculation":"grossSales"},"targets":[],"meta":{"creatorUserId":3,"creatorRealName":"Test user"},"updatedAt":"2025-08-12T16:56:44+02:00","createdAt":"2025-09-05T00:28:03+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"Load additional relations for a key figure. The following relations are available:\n * <ul>\n <li>'dimensions' = Available dimensions of this key figure.<\/li>\n <li>'dimensionValues' = Available dimension values of this key figure.<\/li>\n <\/ul>\n Example: <code>?with[]=dimension&with[]=dimensionValues<\/code>","format":"","in":"query","items":{"type":"string"}},{"name":"dimension","type":"string","required":false,"description":"The specification of a dimension enables the return of the appropriate dimension values.","format":"string","in":"query"},{"name":"keyFigure","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/bi\/key-figures\/global-filters":{"post":{"summary":"Return global filters by given key figure identifiers param: identifiers","description":"Return global filters by given key figure identifiers param: identifiers","tags":["BI"],"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\/bi\/key-figures\/global-filters\/values":{"post":{"summary":"Return global filter values by given criteria identifiers param: identifiers","description":"Return global filter values by given criteria identifiers param: identifiers","tags":["BI"],"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\/bi\/key-figures\/raw-data\/{keyFigureConfigId}":{"get":{"summary":"Return filtered raw data for given key figure","description":"Returns a paginated result of raw data items.\nCan add page - int ,itemsPerPage - int or filters - array as parameters","tags":["BI"],"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":"Page","format":"integer","in":"query"},{"name":"itemsPerPage","type":"integer","required":false,"description":"The number of raw data items to be returned. The default number of files is 50 and the maximum is 250.","format":"integer","in":"query"},{"name":"keyFigureConfigId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"post":{"summary":"Return filtered raw data for given key figure","description":"Returns a paginated result of raw data items.\nCan add page - int ,itemsPerPage - int or filters - array as parameters","tags":["BI"],"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":"Page","format":"integer","in":"query"},{"name":"itemsPerPage","type":"integer","required":false,"description":"The number of raw data items to be returned. The default number of files is 50 and the maximum is 250.","format":"integer","in":"query"},{"name":"keyFigureConfigId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/bi\/key-figures\/raw-data\/{keyFigureConfigId}\/export-spreadsheet":{"post":{"summary":"Export raw data of a given key figure to a spreadsheet (google, microsoft)","description":"Returns <string>\"true\" if operation has been completed successfully, or <string>\"false\" otherwise","tags":["BI"],"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":"spreadsheetURL","type":"string","required":true,"description":"The URL pointing to the spreadsheet","format":"string","in":"query"},{"name":"columnsToExport","type":"array","required":true,"description":"An array containing the columns from raw data which will be exported","format":"","in":"query","items":{"type":"string"}},{"name":"startingCell","type":"string","required":true,"description":"The top-left cell inside the spreadsheet from which the export will fill data","format":"string","in":"query"},{"name":"keyFigureConfigId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/bi\/key-figures\/recalculate":{"post":{"summary":"Recalculates one or more raw data based key figures by key figure config ids","description":"Returns \"1\" if recalculations were queued, or \"0\" otherwise","tags":["BI"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/bi\/key-figures\/results":{"post":{"summary":"Search for key figure calculation results","description":"Search for key figure calculation results,\nreturns KeyFigureResultSearchResponse including KeyFigureResultSearchResult children","tags":["BI"],"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."}},"parameters":[{"in":"body","name":"\/rest\/bi\/key-figures\/results","schema":{"type":"object","properties":{"searchRequests":{"type":"array","items":{"$ref":"#\/definitions\/KeyFigureSearchRequest"}}}}}]}},"\/rest\/bi\/order-types":{"get":{"summary":"Get order types in string format","description":"Returns a list of order types in string format <caption,value>","tags":["BI"],"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\/bi\/raw-data":{"get":{"summary":"Get list of raw data files.","description":"Get list of raw data files. Valid filter combinations: (dataName), (dataName & processStatus), (createdAtTimestamp)","tags":["BI"],"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\/bi\/raw-data\/config":{"get":{"summary":"Returns list of all saved configurations","description":"Returns a list of raw data configurations including their children","tags":["BI"],"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":"Reset all raw data configurations and their children with provided data from the Request","tags":["BI"],"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":"array","required":true,"description":"Resets all saved raw data configurations with given configs","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/bi\/raw-data\/creators":{"get":{"summary":"Get list of all raw data creators","description":"returns list of raw data creators from plenty modules that were not set hidden (by default)","tags":["BI"],"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\/bi\/raw-data\/creators-configs":{"get":{"summary":"Return a list of raw data creators with their configurations","description":"Returns list of paginated raw data creators with their configurations, by default itemsPerPage=50","tags":["BI"],"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":"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 raw data creators to be displayed per page. The default number of raw data creators per page is 50.","format":"integer","in":"query"}]}},"\/rest\/bi\/raw-data\/file":{"get":{"summary":"Get a raw data file from the storage","description":"Get a raw data file from the storage, the storage path of the file must be specified.","tags":["BI"],"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\/bi\/raw-data\/{dataName}":{"delete":{"summary":"Deletes RawData\\Models that are deletable","description":"Deletes RawData\\Models that are deletable if these are not deletable\nthe method will return a json response with the message:\n'Deleting raw data is not allowed for this format'","tags":["BI"],"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":"array","required":true,"description":"List of primary keys of the records to be deleted","format":"","in":"query","items":{"type":"string"}},{"name":"dataName","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/blogs\/post":{"post":{"summary":"Create a blog post","description":"Creates a new blog post.","tags":["Blog"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/BlogPost"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/blogs\/post\/{postId}":{"delete":{"summary":"Delete a blog post","description":"Deletes a blog post based on its ID.","tags":["Blog"],"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":"postId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get a blog post","description":"Gets a blog post based on its ID.","tags":["Blog"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/BlogPost"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"postId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Update a blog post","description":"Updates a blog post based on its ID.","tags":["Blog"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/BlogPost"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"postId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/blogs\/posts":{"get":{"summary":"List blog posts","description":"Gets a paginated list of blog posts.","tags":["Blog"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/BlogPost"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/boards":{"get":{"summary":"List all boards","description":"Gets a list with all boards.","tags":["Boards"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/Board"}},"examples":{"application\/json":[{"id":"da5156cc-819f-5936-bb45-f3669335f68e","boardName":"Alice's side as she did not dare to laugh; and.","plentyIdHash":"dhhp8kyd40qq"},{"id":"8662c4b1-7ccf-5371-b02a-f9cd7485a483","boardName":"Alice in a ring, and begged the Mouse heard.","plentyIdHash":"dhhp8kyd40qq"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 board","description":"Creates a new board.","tags":["Boards"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Board"},"examples":{"application\/json":{"id":"95e7bbbc-5240-56ad-9748-8739db48a42d","boardName":"I shall never get to the porpoise, \"Keep back.","plentyIdHash":"dhhp8kyd40qq"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/boards","schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the board optional"},"boardName":{"type":"string","description":"The name of the board"}}}}]}},"\/rest\/boards\/{boardId}":{"delete":{"summary":"Delete board","description":"Deletes a specific board. The ID of the board must be specified.","tags":["Boards"],"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":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"}]},"get":{"summary":"Get board by ID","description":"Gets a specific board by its ID. The ID of the board must be specified.","tags":["Boards"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Board"},"examples":{"application\/json":{"id":"8e524319-49f2-527d-9c00-3752bc61798f","boardName":"I was a paper label, with the bread-knife.' The.","plentyIdHash":"dhhp8kyd40qq"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"name":"tasksPerPage","type":"integer","required":false,"description":"Maximum number of tasks to list per column","format":"integer","in":"query"}]},"post":{"summary":"Copy board","description":"Copies a specific board. The ID of the board must be specified.","tags":["Boards"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Board"},"examples":{"application\/json":{"id":"6f28f3b2-7f24-52dc-a4f5-9d16d7d41ced","boardName":"White Rabbit, 'and that's why. Pig!' She said.","plentyIdHash":"dhhp8kyd40qq"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"}]},"put":{"summary":"Update board","description":"Updates a specific board. The ID of the board must be specified.","tags":["Boards"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Board"},"examples":{"application\/json":{"id":"8386697e-e87f-562f-b398-6f2fe2d29ad6","boardName":"Queen put on his flappers, '--Mystery, ancient.","plentyIdHash":"dhhp8kyd40qq"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"in":"body","name":"\/rest\/boards\/{boardId}","schema":{"type":"object","properties":{"boardName":{"type":"string","description":"The name of the board optional"}}}}]}},"\/rest\/boards\/{boardId}\/columns":{"get":{"summary":"List all columns of a given board","description":"Lists all columns of a given board. The ID of the board must be specified.","tags":["Board"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/BoardColumn"}},"examples":{"application\/json":[{"id":"71da4d06-35fc-5a1e-963d-a689704ebdcf","boardId":"eb16bc22-967b-3722-898f-b7a52556042e","columnName":"Mind now!' The poor little.","position":0},{"id":"0209f955-885f-5738-89d6-36152b7566ce","boardId":"9296577d-447d-32f1-80c5-86e5cf00bfec","columnName":"Queen will hear you! You.","position":1}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"}]},"post":{"summary":"Create column and assign it to a board","description":"Creates a new column and assigns it to a given board. The ID of the board must be specified.","tags":["Board"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/BoardColumn"},"examples":{"application\/json":{"id":"4dcdec4a-f844-5d31-9e95-a836f0069d2a","boardId":"ad67e8fe-2112-3ce5-bd49-d1ec00acd4f5","columnName":"So she began nibbling at the.","position":2}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"in":"body","name":"\/rest\/boards\/{boardId}\/columns","schema":{"type":"object","properties":{"columnName":{"type":"string","description":"The name of the column"},"position":{"type":"integer","description":"The position"}}}}]}},"\/rest\/boards\/{boardId}\/columns\/{columnId}":{"delete":{"summary":"Delete column","description":"Deletes a specific column. The ID of the board and the ID of column must be specified.","tags":["Board"],"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":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"name":"columnId","type":"string","required":true,"description":"The ID of the column","format":"string","in":"path"}]},"post":{"summary":"Copy column","description":"Copies a specific column. The ID of the board and the ID of the column must be specified.","tags":["Board"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/BoardColumn"},"examples":{"application\/json":{"id":"9bb50338-f72e-5846-a6ee-70afd395fc59","boardId":"ed87f71c-59ef-3933-946b-10cc73b6e051","columnName":"The Footman seemed to think.","position":4}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"name":"columnId","type":"string","required":true,"description":"The ID of the column","format":"string","in":"path"}]},"put":{"summary":"Update column","description":"Updates a specific column. The ID of the board and the ID of the column must be specified.","tags":["Board"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/BoardColumn"},"examples":{"application\/json":{"id":"7b02fe5f-8090-54c6-a259-c4c3f86c22a8","boardId":"14e243b8-5715-3e74-a402-af384d3d221d","columnName":"The first question of course.","position":3}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"name":"columnId","type":"string","required":true,"description":"The ID of the column","format":"string","in":"path"},{"in":"body","name":"\/rest\/boards\/{boardId}\/columns\/{columnId}","schema":{"type":"object","properties":{"columnName":{"type":"string","description":"The name of the column optional"},"position":{"type":"integer","description":"The position optional"}}}}]}},"\/rest\/boards\/{boardId}\/columns\/{columnId}\/position":{"put":{"summary":"Update position of of a column","description":"Updates the position of a specific column. Also updates the positions of all following columns on the same board. The ID of the board and the ID of the column must be specified.","tags":["Board"],"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":"position","type":"integer","required":true,"description":"The position number","format":"integer","in":"query"},{"name":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"name":"columnId","type":"string","required":true,"description":"The ID of the column","format":"string","in":"path"}]}},"\/rest\/boards\/{boardId}\/columns\/{columnId}\/tasks":{"get":{"summary":"List all task of a column","description":"Lists all tasks of a given column. The ID of the board and the ID of the column must be specified.","tags":["Board"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/BoardTask"}},"examples":{"application\/json":[{"id":"082aba70-f7b5-3633-9f51-07c8533b415f","taskName":"When the procession came.","description":"An obstacle that came between Him, and ourselves, and it. Don't let me hear the name again!' 'I.","position":0,"columnId":"eb88f729-ed7f-3721-a4d4-2fb7042b605d","boardId":"cc75317d-9db3-3248-9010-fbe831e4f396","plentyIdHash":"dhhp8kyd40qq"},{"id":"96ed9f46-4b78-32c5-8ab9-a9227eca32db","taskName":"I--' 'Oh, don't talk about.","description":"And so she went on, 'I must be what he did not like the look of things at all, at all!' 'Do as I.","position":1,"columnId":"0d3ea6a4-deae-3e9d-be93-5e0411a2d4e1","boardId":"a63a7aa5-fa7b-353e-8fe0-17caebdaf15b","plentyIdHash":"dhhp8kyd40qq"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"name":"columnId","type":"string","required":true,"description":"The ID of the column","format":"string","in":"path"},{"name":"startAt","type":"integer","required":false,"description":"The position of a task to start listing at","format":"integer","in":"query"},{"name":"tasksPerPage","type":"integer","required":false,"description":"The number of tasks to list per page","format":"integer","in":"query"}]},"post":{"summary":"Create task in specific column","description":"Creates a new task in a specific column. The ID of the board and the ID of the column must be specified.","tags":["Board"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/BoardTask"},"examples":{"application\/json":{"id":"d414d1ae-cc7b-3ef7-8e0a-e791c1848099","taskName":"Alice loudly. 'The idea of.","description":"Ugh, Serpent!' 'But I'm not looking for eggs, I know THAT well enough; don't be particular--Here.","position":2,"columnId":"3b9192c9-88f1-37ee-8f00-b6d0988605d0","boardId":"ab8e4993-5d14-3759-8144-924512b4489a","plentyIdHash":"dhhp8kyd40qq"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"name":"columnId","type":"string","required":true,"description":"The ID of the column","format":"string","in":"path"},{"in":"body","name":"\/rest\/boards\/{boardId}\/columns\/{columnId}\/tasks","schema":{"type":"object","properties":{"taskName":{"type":"string","description":"The name of the task"},"description":{"type":"string","description":"The description of the task optional"},"position":{"type":"integer","description":"The position of the task"},"references":{"type":"array","items":{}}}}}]}},"\/rest\/boards\/{boardId}\/columns\/{columnId}\/tasks\/{taskId}":{"delete":{"summary":"Delete task","description":"Deletes a task. The ID of the board, the ID of the column and the ID of the task must be specified.","tags":["Board"],"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":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"name":"columnId","type":"string","required":true,"description":"The ID of the column","format":"string","in":"path"},{"name":"taskId","type":"string","required":true,"description":"The ID of the task","format":"string","in":"path"}]},"get":{"summary":"Get task by ID","description":"Gets a task by its ID. The ID of the board, the ID of the column and the ID of the task must be specified.","tags":["Board"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/BoardTask"},"examples":{"application\/json":{"id":"78f9c8d3-8365-3923-822f-63cd18952719","taskName":"Hatter: 'let's all move one.","description":"Dodo, pointing to the jury, and the Hatter instead!' CHAPTER VII. A Mad Tea-Party There was.","position":3,"columnId":"c3018315-09f7-39d4-9ac5-27d3297fde2a","boardId":"7415798c-d35d-3a72-9fd3-81b334ee4a32","plentyIdHash":"dhhp8kyd40qq"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"name":"columnId","type":"string","required":true,"description":"The ID of the column","format":"string","in":"path"},{"name":"taskId","type":"string","required":true,"description":"The ID of the task","format":"string","in":"path"}]},"post":{"summary":"Copy task","description":"Copies a specific task. The ID of the board, the ID of the column and the ID of the task must be specified.","tags":["Board"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/BoardTask"},"examples":{"application\/json":{"id":"0ef8c040-0823-3a9f-b92d-235e91a3a406","taskName":"GAVE HER ONE, THEY GAVE HIM.","description":"Alice did not venture to go nearer till she was up to the shore. CHAPTER III. A Caucus-Race and a.","position":5,"columnId":"5b219f13-1024-3db1-a92e-53e934872531","boardId":"f833e270-223c-3704-a63f-0cab73c55d48","plentyIdHash":"dhhp8kyd40qq"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"name":"columnId","type":"string","required":true,"description":"The ID of the column","format":"string","in":"path"},{"name":"taskId","type":"string","required":true,"description":"The ID of the task","format":"string","in":"path"}]},"put":{"summary":"Update task","description":"Updates a task. The ID of the board, the ID of the column and the ID of the task must be specified.","tags":["Board"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/BoardTask"},"examples":{"application\/json":{"id":"61099b83-ea56-36da-b99d-79809375065c","taskName":"I've fallen by this time?'.","description":"I should like it very nice, (it had, in fact, a sort of life! I do wonder what they'll do well.","position":4,"columnId":"3e4c2ed6-1d88-3fdc-abf6-3526bbdd9389","boardId":"4285ba1e-70d4-30f6-86a7-87e6f3eca614","plentyIdHash":"dhhp8kyd40qq"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"name":"columnId","type":"string","required":true,"description":"The ID of the column","format":"string","in":"path"},{"name":"taskId","type":"string","required":true,"description":"The ID of the task","format":"string","in":"path"},{"in":"body","name":"\/rest\/boards\/{boardId}\/columns\/{columnId}\/tasks\/{taskId}","schema":{"type":"object","properties":{"boardId":{"type":"string","description":"The ID of the board optional"},"columnId":{"type":"string","description":"The ID of the column optional"},"taskName":{"type":"string","description":"The name of the task optional"},"description":{"type":"string","description":"The description of the task optional"},"position":{"type":"integer","description":"The position of the task optional"}}}}]}},"\/rest\/boards\/{boardId}\/columns\/{columnId}\/tasks\/{taskId}\/position":{"put":{"summary":"Update task position","description":"Updates the position of a task. The ID of the board, the ID of the column and the ID of the task must be specified.","tags":["Board"],"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":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"name":"position","type":"integer","required":true,"description":"The new position of the task","format":"integer","in":"query"},{"name":"columnId","type":"string","required":true,"description":"The ID of the column the task belongs to","format":"string","in":"path"},{"name":"taskId","type":"string","required":true,"description":"The ID of the task","format":"string","in":"path"}]}},"\/rest\/boards\/{boardId}\/columns\/{columnId}\/tasks\/{taskId}\/references":{"post":{"summary":"Create reference","description":"Creates a new reference from a given task to a contact or a ticket. The ID of the board, the ID of the column and the ID of the task must be specified.","tags":["Board"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/BoardTaskReference"},"examples":{"application\/json":{"id":"5d9dc119-90c2-3f70-88c3-9edcd23674a5","referenceValue":"item-6199212","taskId":"48c61bb5-dd8d-3a05-8583-b4798b28ad24","plentyIdHash":"dhhp8kyd40qq"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"name":"columnId","type":"string","required":true,"description":"The ID of the column","format":"string","in":"path"},{"name":"taskId","type":"string","required":true,"description":"The ID of the task","format":"string","in":"path"},{"name":"referenceValue","type":"string","required":true,"description":"Reference type followed by foreign ID of the referenced object. Syntax: TYPE-ID Example: user-123456 Types: user,ticket,contact,order,item","format":"string","in":"query"}]}},"\/rest\/boards\/{boardId}\/columns\/{columnId}\/tasks\/{taskId}\/references\/{referenceId}":{"delete":{"summary":"Delete reference from a given task","description":"Deletes a reference from a given task. The ID of the board, the ID of the column, the ID of the task and the ID of the reference must be specified.","tags":["Board"],"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":"boardId","type":"string","required":true,"description":"The ID of the task","format":"string","in":"path"},{"name":"columnId","type":"string","required":true,"description":"The ID of the column","format":"string","in":"path"},{"name":"taskId","type":"string","required":true,"description":"The ID of the task","format":"string","in":"path"},{"name":"referenceId","type":"string","required":true,"description":"The ID of the reference","format":"string","in":"path"}]}},"\/rest\/boards\/{boardId}\/columns\/{columnId}\/tasks\/{taskId}\/references\/{referenceType}\/{referenceKey}":{"get":{"summary":"Check reference key","description":"Checks the reference key. The ID of the board, the ID of the column and the ID of the task as well as the reference type and the reference key must be specified.","tags":["Board"],"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":"boardId","type":"string","required":true,"description":"The ID of the board","format":"string","in":"path"},{"name":"columnId","type":"string","required":true,"description":"The ID of the column","format":"string","in":"path"},{"name":"taskId","type":"string","required":true,"description":"The ID of the task","format":"string","in":"path"},{"name":"referenceType","type":"string","required":true,"description":"The type of the reference","format":"string","in":"path"},{"name":"referenceKey","type":"integer","required":true,"description":"The key of the reference","format":"integer","in":"path"}]}},"\/rest\/catalogs\/catalogs":{"get":{"summary":"Gets a list of Catalogs","description":"Gets a paginated list of the Catalogs.","tags":["Catalog"],"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":"Create Catalog","description":"Creates a Catalog","tags":["Catalog"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Catalog"},"examples":{"application\/json":{"active":false,"showMandatoryFields":true,"master":{"parent":null},"errors":{"groups":[]},"errorCount":0,"id":"78acdfdd-31d5-3b9a-a447-7fe56f841624","name":"Talia Koepp","template":"b7d7f89b-46c3-3b9d-a221-e64d511602f6","data":{"0":67,"1":193,"2":107,"customMappings":[],"mappings":[],"filters":[]},"settings":{"csv":{"delimiter":"comma","enclosure":"double","headerRowIncluded":true},"format":{"fileName":"","numberRange":""},"url":{"webstore":null,"public":{"enabled":true,"useToken":false,"useHash":true,"token":""},"private":{"useHash":true}},"notice":{"notification":{"enabled":true},"email":{"enabled":false}},"async":{"performance":false},"devcache":false,"bundle":{"enabled":true,"size":3},"export":{"scheduleDays":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"skipEmptyFiles":false}},"with":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/catalogs\/catalogs\/activate\/{id}":{"post":{"summary":"Activate or deactivate Catalog","description":"Activates or deactivates a Catalog based on its ID.","tags":["Catalog"],"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"}]}},"\/rest\/catalogs\/catalogs\/archive":{"get":{"summary":"Get archive","description":"Gets the list of archived Catalogs. An archived Catalog is a deleted Catalog.","tags":["Catalog"],"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\/catalogs\/catalogs\/archive\/{id}\/restore":{"post":{"summary":"Restore archived Catalog","description":"Restores an archived Catalog based on its ID. An archived Catalog is a deleted Catalog.","tags":["Catalog"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Catalog"},"examples":{"application\/json":{"active":false,"showMandatoryFields":false,"master":{"parent":null},"errors":{"groups":[]},"errorCount":0,"id":"0206cca5-becf-3878-81f2-56cbe95d9f63","name":"Maymie Lueilwitz","template":"5f11fe18-0fde-37e3-aeb3-da86bf5ea6a0","data":{"0":73,"1":72,"2":80,"customMappings":[],"mappings":[],"filters":[]},"settings":{"csv":{"delimiter":"comma","enclosure":"double","headerRowIncluded":true},"format":{"fileName":"","numberRange":""},"url":{"webstore":null,"public":{"enabled":true,"useToken":false,"useHash":true,"token":""},"private":{"useHash":true}},"notice":{"notification":{"enabled":true},"email":{"enabled":false}},"async":{"performance":false},"devcache":false,"bundle":{"enabled":true,"size":3},"export":{"scheduleDays":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"skipEmptyFiles":false}},"with":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/catalogs\/catalogs\/copy":{"put":{"summary":"Copy Catalog","description":"Copies one or multiple Catalogs.","tags":["Catalog"],"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\/catalogs\/catalogs\/import":{"post":{"summary":"Import a catalog.","description":"Imports the catalog. The catalog ID is required.","tags":["Catalog"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Catalog"},"examples":{"application\/json":{"active":false,"showMandatoryFields":false,"master":{"parent":null},"errors":{"groups":[]},"errorCount":0,"id":"5e3d2553-b747-3af6-b314-cadc1634ba1f","name":"Prof. Aiden Franecki DVM","template":"81d369b0-3d20-3e4e-bedc-2541767f4d8a","data":{"0":191,"1":41,"2":222,"customMappings":[],"mappings":[],"filters":[]},"settings":{"csv":{"delimiter":"comma","enclosure":"double","headerRowIncluded":true},"format":{"fileName":"","numberRange":""},"url":{"webstore":null,"public":{"enabled":true,"useToken":false,"useHash":true,"token":""},"private":{"useHash":true}},"notice":{"notification":{"enabled":true},"email":{"enabled":false}},"async":{"performance":false},"devcache":false,"bundle":{"enabled":true,"size":3},"export":{"scheduleDays":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"skipEmptyFiles":false}},"with":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/catalogs\/catalogs\/migrate":{"post":{"summary":"Migrate Catalogs","description":"Migrates Catalogs from Dynamo DB to S3","tags":["Catalog"],"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\/catalogs\/catalogs\/schedule\/days":{"get":{"summary":"Return available schedule days list","description":"Returns available schedules days list with key and translated value","tags":["Catalog"],"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\/catalogs\/catalogs\/token":{"get":{"summary":"Generate token","description":"Generates an alphanumeric token","tags":["Catalog"],"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\/catalogs\/catalogs\/{catalogId}\/copy":{"put":{"summary":"Copy Catalog format","description":"Copies a Catalog format based on its ID.","tags":["Catalog"],"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":"catalogId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/catalogs\/catalogs\/{id}":{"delete":{"summary":"Delete Catalog","description":"Deletes a Catalog based on its ID.","tags":["Catalog"],"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 Catalog","description":"Gets a specific Catalog based on its ID.","tags":["Catalog"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Catalog"},"examples":{"application\/json":{"active":true,"showMandatoryFields":false,"master":{"parent":null},"errors":{"groups":[]},"errorCount":0,"id":"6646de96-c0ff-3418-9842-0891eee43c76","name":"Ms. Lilian Grant","template":"72184b21-485c-33e8-9a5d-c5137dcf6eba","data":{"0":87,"1":249,"2":58,"customMappings":[],"mappings":[],"filters":[]},"settings":{"csv":{"delimiter":"comma","enclosure":"double","headerRowIncluded":true},"format":{"fileName":"","numberRange":""},"url":{"webstore":null,"public":{"enabled":true,"useToken":false,"useHash":true,"token":""},"private":{"useHash":true}},"notice":{"notification":{"enabled":true},"email":{"enabled":false}},"async":{"performance":false},"devcache":false,"bundle":{"enabled":true,"size":3},"export":{"scheduleDays":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"skipEmptyFiles":false}},"with":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 Catalog","description":"Updates a Catalog based on its ID.","tags":["Catalog"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Catalog"},"examples":{"application\/json":{"active":true,"showMandatoryFields":false,"master":{"parent":null},"errors":{"groups":[]},"errorCount":0,"id":"26e26e38-d18e-35a9-b206-a76126c3edc0","name":"Domenic Champlin I","template":"42b69283-0866-33d2-8288-3751fbf6b69a","data":{"0":102,"1":41,"2":116,"customMappings":[],"mappings":[],"filters":[]},"settings":{"csv":{"delimiter":"comma","enclosure":"double","headerRowIncluded":true},"format":{"fileName":"","numberRange":""},"url":{"webstore":null,"public":{"enabled":true,"useToken":false,"useHash":true,"token":""},"private":{"useHash":true}},"notice":{"notification":{"enabled":true},"email":{"enabled":false}},"async":{"performance":false},"devcache":false,"bundle":{"enabled":true,"size":3},"export":{"scheduleDays":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"skipEmptyFiles":false}},"with":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/catalogs\/catalogs\/{id}\/content":{"get":{"summary":"Get Catalog content","description":"Gets the content of a Catalog based on its ID.","tags":["Catalog"],"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"}]},"put":{"summary":"Update Catalog content","description":"Updates the content of the Catalog.","tags":["Catalog"],"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"}]}},"\/rest\/catalogs\/catalogs\/{id}\/export":{"get":{"summary":"Export a catalog.","description":"Exports the catalog. The catalog ID is required.","tags":["Catalog"],"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"}]}},"\/rest\/catalogs\/catalogs\/{id}\/preview":{"get":{"summary":"Get preview catalog","description":"Gets the preview for an export with a specific catalog","tags":["Catalog"],"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":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/catalogs\/catalogs\/{id}\/preview\/vdi":{"get":{"summary":"Get preview VDI catalog","description":"Gets the preview for an export with a specific VDI catalog","tags":["Catalog"],"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."}},"parameters":[{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/catalogs\/catalogs\/{id}\/url\/private":{"get":{"summary":"Build private download url","description":"Builds the private download url with optional data\nThe data should use the same structure as the catalog options","tags":["Catalog"],"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"}]}},"\/rest\/catalogs\/catalogs\/{id}\/url\/public":{"get":{"summary":"Build public download url","description":"Builds the public download url with optional data\nThe data should use the same structure as the catalog options","tags":["Catalog"],"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"}]}},"\/rest\/catalogs\/catalogs\/{id}\/versions":{"get":{"summary":"Lists Catalog versions","description":"Lists all versions of a specific Catalog, based on its ID.","tags":["Catalog"],"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":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/catalogs\/catalogs\/{id}\/versions\/{versionId}":{"get":{"summary":"Gets Catalog by version","description":"Gets a specific catalog based on its ID and version.","tags":["Catalog"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Catalog"},"examples":{"application\/json":{"active":false,"showMandatoryFields":true,"master":{"parent":null},"errors":{"groups":[]},"errorCount":0,"id":"93bb86e0-8c7d-3e13-b51c-dc697e0e7cbe","name":"Destini Johnson","template":"c6cabeff-e088-35a3-ab55-b6816d94930a","data":{"0":74,"1":203,"2":116,"customMappings":[],"mappings":[],"filters":[]},"settings":{"csv":{"delimiter":"comma","enclosure":"double","headerRowIncluded":true},"format":{"fileName":"","numberRange":""},"url":{"webstore":null,"public":{"enabled":true,"useToken":false,"useHash":true,"token":""},"private":{"useHash":true}},"notice":{"notification":{"enabled":true},"email":{"enabled":false}},"async":{"performance":false},"devcache":false,"bundle":{"enabled":true,"size":3},"export":{"scheduleDays":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"skipEmptyFiles":false}},"with":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"versionId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/catalogs\/catalogs\/{id}\/versions\/{versionId}\/restore":{"post":{"summary":"Restore version of Catalog","description":"Restores a Catalog to a previous version.","tags":["Catalog"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Catalog"},"examples":{"application\/json":{"active":false,"showMandatoryFields":true,"master":{"parent":null},"errors":{"groups":[]},"errorCount":0,"id":"72683f5e-5ad3-3f9f-9929-0a90f57394ce","name":"Emiliano McLaughlin DVM","template":"d161a30f-2525-3278-a303-97b4a14d38ad","data":{"0":34,"1":7,"2":251,"customMappings":[],"mappings":[],"filters":[]},"settings":{"csv":{"delimiter":"comma","enclosure":"double","headerRowIncluded":true},"format":{"fileName":"","numberRange":""},"url":{"webstore":null,"public":{"enabled":true,"useToken":false,"useHash":true,"token":""},"private":{"useHash":true}},"notice":{"notification":{"enabled":true},"email":{"enabled":false}},"async":{"performance":false},"devcache":false,"bundle":{"enabled":true,"size":3},"export":{"scheduleDays":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"skipEmptyFiles":false}},"with":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"versionId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/catalogs\/connection\/check\/{protocol}":{"post":{"summary":"Check the connection to FTP, FTPS, SFTP","description":"Checks connection to identify possible issues. Can handle FTP, FTPS, SFTP","tags":["Catalog"],"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":"protocol","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/catalogs\/statuses":{"get":{"summary":"Get a list of Catalog statuses","description":"Gets a list of Catalog statuses","tags":["Catalog"],"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\/catalogs\/statuses\/{id}":{"get":{"summary":"Get Catalog status","description":"Gets a specific Catalog status based on its ID.","tags":["Catalog"],"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."}},"parameters":[{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/catalogs\/statuses\/{id}\/data":{"get":{"summary":"Get status data","description":"Gets a status data. For testing purposes.","tags":["Catalog"],"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."}},"parameters":[{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/catalogs\/statuses\/{id}\/histories":{"get":{"summary":"List status histories","description":"Lists all status histories. For testing purposes.","tags":["Catalog"],"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."}},"parameters":[{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/catalogs\/statuses\/{id}\/histories\/{filename}":{"get":{"summary":"Get a single status history file","description":"Gets a single status history file. For testing purposes.","tags":["Catalog"],"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."}},"parameters":[{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"name":"filename","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/catalogs\/statuses\/{id}\/logs":{"get":{"summary":"List status logs","description":"Lists all status logs. For testing purposes.","tags":["Catalog"],"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."}},"parameters":[{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/catalogs\/statuses\/{id}\/performances":{"get":{"summary":"List status performances","description":"Lists all status performances. For testing purposes.","tags":["Catalog"],"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."}},"parameters":[{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/catalogs\/statuses\/{statusId}\/cancel":{"post":{"summary":"Cancel export runs","description":"Cancel export and live export runs.","tags":["Catalog"],"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."}},"parameters":[{"name":"statusId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/categories":{"get":{"summary":"List categories","description":"Search for categories.","tags":["Category"],"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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"parentCategoryId":null,"level":1,"type":"item","linklist":"Y","right":"customer","sitemap":"Y"},{"parentCategoryId":null,"level":1,"type":"item","linklist":"N","right":"all","sitemap":"Y"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"with","type":"string","required":false,"description":"Includes the detail information, the active clients (stores) list of the category, all linked tags and their information and\/or the linked Elmar category for each client. Available values: details, clients, elmarCategories, tags ","format":"string","in":"query"},{"name":"lang","type":"string","required":false,"description":"The <a href='https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#countries' target='_blank'>languages<\/a> of the category detail information. Several languages must be separated by commas. If no language filter is set, the default language of the system is used.","format":"string","in":"query"},{"name":"type","type":"string","required":false,"description":"The category type. Available values: item, container, content, blog ","format":"string","in":"query"},{"name":"parentId","type":"integer","required":false,"description":"The unique ID of the parent category","format":"integer","in":"query"},{"name":"plentyId","type":"integer","required":false,"description":"The unique plenty ID of the client (store)","format":"integer","in":"query"},{"name":"name","type":"string","required":false,"description":"The name of the category","format":"string","in":"query"},{"name":"level","type":"string","required":false,"description":"The level of the category","format":"string","in":"query"},{"name":"linklist","type":"boolean","required":false,"description":"Filter for the linklist of categories","format":"boolean","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":"tagId","type":"integer","required":false,"description":"Filter restricts the list of results to items with a specific tag","format":"integer","in":"query"},{"name":"metaKeywords","type":"string","required":false,"description":"Filter restricts the list of results to items with a specific meta keyword. Possible search operators are 'like' and 'eq'.","format":"string","in":"query"}]},"post":{"summary":"Create new categories","description":"Creates new categories.","tags":["Category"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/Category"}},"examples":{"application\/json":[{"parentCategoryId":null,"level":1,"type":"item","linklist":"N","right":"all","sitemap":"Y"},{"parentCategoryId":null,"level":1,"type":"container","linklist":"N","right":"customer","sitemap":"N"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/categories","schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the category optional"},"parentCategoryId":{"type":"integer","description":"The ID of the category's parent category. Value is null if category level is 1. optional"},"type":{"type":"string","description":"The category type of the category allowed values are blog, container, item, content"},"linklist":{"type":"string","description":"Flag that indicates if the category will be displayed in the online store's navigation. optional allowed values are Y, N"},"right":{"type":"string","description":"Flag that indicates who can see this category. all = Category is\nvisible to all visitors of the online store.customer = Category and all of its subcategories are visible to\nvisitors of the online store that have logged in only. Visitors that are not logged in are redirected to the login page. optional allowed values are all, customer"},"sitemap":{"type":"string","description":"Flag that indicates if the category will be included in the sitemap. optional allowed values are Y, N"},"details":{"type":"array","items":{"$ref":"#\/definitions\/CategoryDetails"}},"plentyId":{"type":"integer","description":"The unique plenty ID of the client (store)"},"name":{"type":"string","description":"The name of the category. The same category name can be used more than once in different categories or on different category levels. However, category names must be unique within the same category or level."},"lang":{"type":"string","description":"The language of the category allowed values are en, de, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"description":{"type":"string","description":"The category text. The description is inserted into the online store using template variables. optional"},"description2":{"type":"string","description":"The category text 2. The description 2 is inserted into the online store using template variables. optional"},"shortDescription":{"type":"string","description":"The short description of the category. The short description can be inserted into the store's design using template variables. optional"},"metaDescription":{"type":"string","description":"The meta description of the category. 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"},"nameUrl":{"type":"string","description":"The category name to be used for the category's URL. The same URL name can be used more than once in different categories or on different category levels. However, URL names must be unique within the same category or level. The URL name should not be changed once the category is indexed by search engines. If no URL name is specified, the name will automatically be used as the URL name when the category is created.Important: Name should contain ASCII code only and no special characters. The following character strings may not be used as prefixes to URL names: a-, b-, c-, f-, fa-, p-, t-. These prefixes will be removed automatically. For instance, a-class will be changed to class automatically. However, the URL name aclass can be used for a category named A-class. optional"},"image":{"type":"string","description":"The ID to the image1 of the category. optional"},"image2":{"type":"string","description":"The ID to the image2 of the category. optional"},"position":{"type":"integer","description":"The position of the category within a category level. optional"},"itemListView":{"type":"string","description":"The template the category is linked to for the category overview. The template determines what the category overview will look like for this category. This option is available for categories of the type Item only. Possible values: ItemViewCategoriesList, ItemViewCategoriesList2 to ItemViewCategoriesList10. optional allowed values are ItemViewCategoriesList, ItemViewCategoriesList2, ItemViewCategoriesList3, ItemViewCategoriesList4, ItemViewCategoriesList5, ItemViewCategoriesList6, ItemViewCategoriesList7, ItemViewCategoriesList8, ItemViewCategoriesList9, ItemViewCategoriesList10"},"singleItemView":{"type":"string","description":"The template the category is linked to for the single item view. The template determines the appearance of the single item design for this category. This option is available for categories of the type Item only. Possible values: ItemViewSingleItem, ItemViewSingleItem2 to ItemViewSingleItem5. optional allowed values are ItemViewSingleItem, ItemViewSingleItem2, ItemViewSingleItem3, ItemViewSingleItem4, ItemViewSingleItem5"},"pageView":{"type":"string","description":"optional allowed values are PageDesignContent, PageDesignCheckout, PageDesignCustom, PageDesignCustom2, PageDesignCustom3"},"fulltext":{"type":"boolean","description":"Flag that indicates if the complete category text, i.e. the complete description, will be searched.Y = Complete text will be searched.N = Text will not be searched completely. optional allowed values are Y, N"},"metaRobots":{"type":"string","description":"Values from the meta element Robots are analyzed by Web crawlers. These values tell the crawler what it should do with the page and with the links on the page.all = Include this category in the search engine index and follow the links on the page.index = Include in the search engine index.nofollow = Do not follow the links on the page.noindex = Do not include in the search engine index.nofollow, noindex = Do not follow the links and do not include the category in the search engine index. optional allowed values are ALL, INDEX, NOFOLLOW, NOINDEX, NOINDEX_NOFOLLOW"},"clients":{"type":"array","items":{"$ref":"#\/definitions\/CategoryClient"}},"elmarCategories":{"type":"array","items":{"$ref":"#\/definitions\/CategoryProperty"}},"categoryId":{"type":"integer","description":"The unique ID of the category optional"},"marketId":{"type":"number","description":"The unique ID of the referrer optional"},"value":{"type":"string","description":"The category of the referrer"}}}}]},"put":{"summary":"Update categories","description":"Updates existing categories.","tags":["Category"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/Category"}},"examples":{"application\/json":[{"parentCategoryId":null,"level":1,"type":"blog","linklist":"N","right":"customer","sitemap":"N"},{"parentCategoryId":null,"level":1,"type":"item","linklist":"Y","right":"all","sitemap":"N"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/categories","schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the category"},"parentCategoryId":{"type":"integer","description":"The ID of the category's parent category. Value is null if category level is 1. optional"},"type":{"type":"string","description":"The category type of the category optional allowed values are content, item, container, blog"},"linklist":{"type":"string","description":"Flag that indicates if the category will be displayed in the online store's navigation. optional allowed values are Y, N"},"sitemap":{"type":"string","description":"Flag that indicates if the category will be included in the sitemap. optional allowed values are Y, N"},"right":{"type":"string","description":"Flag that indicates who can see this category. all = Category is\nvisible to all visitors of the online store.customer = Category and all of its subcategories are visible to\nvisitors of the online store that have logged in only. Visitors that are not logged in are redirected to the login page. optional allowed values are all, customer"},"details":{"type":"array","items":{"$ref":"#\/definitions\/CategoryDetails"}},"plentyId":{"type":"integer","description":"The unique plenty ID of the client (store)"},"name":{"type":"string","description":"The name of the category. The same category name can be used more than once in different categories or on different category levels. However, category names must be unique within the same category or level."},"lang":{"type":"string","description":"The language of the category allowed values are en, de, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"description":{"type":"string","description":"The category text. The description is inserted into the online store using template variables. optional"},"description2":{"type":"string","description":"The category text 2. The description 2 is inserted into the online store using template variables. optional"},"shortDescription":{"type":"string","description":"The short description of the category. The short description can be inserted into the store's design using template variables. optional"},"metaDescription":{"type":"string","description":"The meta description of the category. 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"},"nameUrl":{"type":"string","description":"The category name to be used for the category's URL. The same URL name can be used more than once in different categories or on different category levels. However, URL names must be unique within the same category or level. The URL name should not be changed once the category is indexed by search engines. If no URL name is specified, the name will automatically be used as the URL name when the category is created.Important: Name should contain ASCII code only and no special characters. The following character strings may not be used as prefixes to URL names: a-, b-, c-, f-, fa-, p-, t-. These prefixes will be removed automatically. For instance, a-class will be changed to class automatically. However, the URL name aclass can be used for a category named A-class. optional"},"image":{"type":"string","description":"The ID to the image1 of the category. optional"},"image2":{"type":"string","description":"The ID to the image2 of the category. optional"},"position":{"type":"integer","description":"The position of the category within a category level. optional"},"itemListView":{"type":"string","description":"The template the category is linked to for the category overview. The template determines what the category overview will look like for this category. This option is available for categories of the type Item only. Possible values: ItemViewCategoriesList, ItemViewCategoriesList2 to ItemViewCategoriesList10. optional allowed values are ItemViewCategoriesList, ItemViewCategoriesList2, ItemViewCategoriesList3, ItemViewCategoriesList4, ItemViewCategoriesList5, ItemViewCategoriesList6, ItemViewCategoriesList7, ItemViewCategoriesList8, ItemViewCategoriesList9, ItemViewCategoriesList10"},"singleItemView":{"type":"string","description":"The template the category is linked to for the single item view. The template determines the appearance of the single item design for this category. This option is available for categories of the type Item only. Possible values: ItemViewSingleItem, ItemViewSingleItem2 to ItemViewSingleItem5. optional allowed values are ItemViewSingleItem, ItemViewSingleItem2, ItemViewSingleItem3, ItemViewSingleItem4, ItemViewSingleItem5"},"pageView":{"type":"string","description":"optional allowed values are PageDesignContent, PageDesignCheckout, PageDesignCustom, PageDesignCustom2, PageDesignCustom3"},"fulltext":{"type":"boolean","description":"Flag that indicates if the complete category text, i.e. the complete description, will be searched.Y = Complete text will be searched.N = Text will not be searched completely. optional allowed values are Y, N"},"metaRobots":{"type":"string","description":"Values from the meta element Robots are analyzed by Web crawlers. These values tell the crawler what it should do with the page and with the links on the page.all = Include this category in the search engine index and follow the links on the page.index = Include in the search engine index.nofollow = Do not follow the links on the page.noindex = Do not include in the search engine index.nofollow, noindex = Do not follow the links and do not include the category in the search engine index. optional allowed values are ALL, INDEX, NOFOLLOW, NOINDEX, NOINDEX_NOFOLLOW"},"clients":{"type":"array","items":{"$ref":"#\/definitions\/CategoryClient"}},"elmarCategories":{"type":"array","items":{"$ref":"#\/definitions\/CategoryProperty"}},"categoryId":{"type":"integer","description":"The unique ID of the category optional"},"marketId":{"type":"number","description":"The unique ID of the referrer"},"value":{"type":"string","description":"The category of the referrer"}}}}]}},"\/rest\/categories\/{categoryId}\/documents":{"get":{"summary":"List documents of a category","description":"Lists the documents of a category. The ID of the category 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"type":"dunning_letter","number":3,"numberWithPrefix":"unde","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":8,"source":"soap","displayDate":"1986-11-05T08:37:44+01:00","status":"done"},{"type":"returns_label","number":74327,"numberWithPrefix":"dolorum","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":5,"source":"paypal","displayDate":"1998-04-18T19:06:22+02:00","status":"done"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","format":"integer","in":"path"}]},"post":{"summary":"Upload category documents","description":"Uploads documents to a category. The ID of the category must be specified.","tags":["Document"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/Document"}},"examples":{"application\/json":[{"type":"correction_document","number":229947193,"numberWithPrefix":"animi","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":10,"source":"paypal","displayDate":"2004-12-24T16:07:41+01:00","status":"done"},{"type":"dunning_letter","number":684,"numberWithPrefix":"maiores","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":6,"source":"admin","displayDate":"1990-05-02T21:14:34+02:00","status":"done"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"documents","type":"array","required":true,"description":"The array with the category documents","format":"","in":"query","items":{"type":"string"}},{"name":"categoryId","type":"integer","required":true,"description":"The ID of the category","format":"integer","in":"path"},{"name":"number","type":"integer","required":false,"description":"The document number","format":"integer","in":"query"},{"name":"numberWithPrefix","type":"string","required":false,"description":"Number with prefix","format":"string","in":"query"},{"name":"directoryId","type":"integer","required":false,"description":"The directory ID","format":"integer","in":"query"},{"name":"displayDate","type":"string","required":false,"description":" The date displayed on the document","format":"string","in":"query"},{"in":"body","name":"\/rest\/categories\/{categoryId}\/documents","schema":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the document optional"},"type":{"type":"string","description":"The type of the document. The following types are available:\n\n admin\n blog\n category\n correction_document\n credit_note\n credit_note_external\n customer\n delivery_note\n dunning_letter\n ebics_hash\n facet\n invoice\n invoice_external\n pos_invoice\n pos_invoice_cancellation\n item\n multi_credit_note\n multi_invoice\n offer\n order_confirmation\n pickup_delivery\n receipt\n refund_reversal\n reorder\n repair_bill\n return_note\n reversal_document\n settlement_report\n success_confirmation\n ticket\n webshop\n webshop_customer\n z_report\n shipping_label\n shipping_export_label\n returns_label\n reversal_dunning_letter\n allowed values are receipt, z_report, invoice_external, invoice, pos_invoice, pos_coupon_receipt, delivery_note, credit_note, order_confirmation, offer, cancellation, reorder, dunning_letter, repair_bill, pickup_delivery, till_count, return_note, success_confirmation, multi_invoice, multi_credit_note, customer, ticket, item, webshop, pos_invoice_cancellation, webshop_customer, blog, admin, correction_document, ebics_hash, category, facet, settlement_report, reversal_document, reversal_dunning_letter, reversal_refund, shipping_label, shipping_export_label, pro_forma_invoice, returns_label, po_delivery_note, credit_note_external, uploaded, order_custom, incoming_items_receipt, incoming_items_register, cash_journal, sepa_direct_debit"},"number":{"type":"integer","description":"The document number optional"},"numberWithPrefix":{"type":"string","description":"The document number with prefix optional"},"content":{"type":"string","description":"The base64 encoded content of the document."},"displayDate":{"type":"string","description":"The date displayed on the document optional"},"source":{"type":"string","description":"The source where the document was generated. Possible sources are 'klarna',\n'soap', 'admin', 'hitmeister', 'paypal' and 'rest'. optional allowed values are klarna, soap, admin, hitmeister, paypal, rest"},"endOfRetentionPeriod":{"type":"array","items":{}},"tags":{"type":"array","items":{}}}}}]}},"\/rest\/categories\/{categoryId}\/documents\/downloads":{"get":{"summary":"Download category documents","description":"Downloads the documents of a category as a zip file. The ID of the category 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":"categoryId","type":"integer","required":true,"description":"The ID of the category","format":"integer","in":"path"}]}},"\/rest\/categories\/{categoryId}\/documents\/{documentId}":{"delete":{"summary":"Delete a category document.","description":"Deletes a category document. 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":"categoryId","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"name":"documentId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/categories\/{id}":{"delete":{"summary":"Deletes a category","description":"Deletes a category. The ID of the category must be specified.","tags":["Category"],"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 category","description":"Gets a category specified by categoryId.","tags":["Category"],"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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"parentCategoryId":null,"level":1,"type":"container","linklist":"Y","right":"all","sitemap":"N"},{"parentCategoryId":null,"level":1,"type":"item","linklist":"N","right":"customer","sitemap":"N"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","format":"integer","in":"path"},{"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":"with","type":"string","required":false,"description":"Includes the detail information, the active clients (stores) list of the category and\/or the linked Elmar category for each client. Available values: details, clients, elmarCategories ","format":"string","in":"query"},{"name":"lang","type":"string","required":false,"description":"The <a href='https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#countries' target='_blank'>languages<\/a> of the category detail information. Several languages must be separated by commas. If no language filter is set, the default language of the system is used.","format":"string","in":"query"},{"name":"type","type":"string","required":false,"description":"The category type. Available values: item, container, content, blog ","format":"string","in":"query"},{"name":"parentId","type":"integer","required":false,"description":"The unique ID of the parent category","format":"integer","in":"query"},{"name":"plentyId","type":"integer","required":false,"description":"The unique plenty ID of the client (store)","format":"integer","in":"query"},{"name":"name","type":"string","required":false,"description":"The name of the category","format":"string","in":"query"},{"name":"level","type":"string","required":false,"description":"The level of the category","format":"string","in":"query"},{"name":"linklist","type":"boolean","required":false,"description":"Filter for the linklist of categories","format":"boolean","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"}]},"put":{"summary":"Updates one category","description":"Updates an existing category. The ID of the category must be specified.","tags":["Category"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Category"},"examples":{"application\/json":{"parentCategoryId":null,"level":1,"type":"blog","linklist":"Y","right":"customer","sitemap":"N"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/categories\/{id}","schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the category"},"parentCategoryId":{"type":"integer","description":"The ID of the category's parent category. Value is null if category level is 1. optional"},"type":{"type":"string","description":"The category type of the category optional allowed values are content, item, container, blog"},"linklist":{"type":"string","description":"Flag that indicates if the category will be displayed in the online store's navigation. optional allowed values are Y, N"},"sitemap":{"type":"string","description":"Flag that indicates if the category will be included in the sitemap. optional allowed values are Y, N"},"right":{"type":"string","description":"Flag that indicates who can see this category. all = Category is\nvisible to all visitors of the online store.customer = Category and all of its subcategories are visible to\nvisitors of the online store that have logged in only. Visitors that are not logged in are redirected to the login page. optional allowed values are all, customer"},"details":{"type":"array","items":{"$ref":"#\/definitions\/CategoryDetails"}},"plentyId":{"type":"integer","description":"The unique plenty ID of the client (store)"},"name":{"type":"string","description":"The name of the category. The same category name can be used more than once in different categories or on different category levels. However, category names must be unique within the same category or level."},"lang":{"type":"string","description":"The language of the category allowed values are en, de, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"description":{"type":"string","description":"The category text. The description is inserted into the online store using template variables. optional"},"description2":{"type":"string","description":"The category text 2. The description 2 is inserted into the online store using template variables. optional"},"shortDescription":{"type":"string","description":"The short description of the category. The short description can be inserted into the store's design using template variables. optional"},"metaDescription":{"type":"string","description":"The meta description of the category. 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"},"nameUrl":{"type":"string","description":"The category name to be used for the category's URL. The same URL name can be used more than once in different categories or on different category levels. However, URL names must be unique within the same category or level. The URL name should not be changed once the category is indexed by search engines. If no URL name is specified, the name will automatically be used as the URL name when the category is created.Important: Name should contain ASCII code only and no special characters. The following character strings may not be used as prefixes to URL names: a-, b-, c-, f-, fa-, p-, t-. These prefixes will be removed automatically. For instance, a-class will be changed to class automatically. However, the URL name aclass can be used for a category named A-class. optional"},"image":{"type":"string","description":"The ID to the image1 of the category. optional"},"image2":{"type":"string","description":"The ID to the image2 of the category. optional"},"position":{"type":"integer","description":"The position of the category within a category level. optional"},"itemListView":{"type":"string","description":"The template the category is linked to for the category overview. The template determines what the category overview will look like for this category. This option is available for categories of the type Item only. Possible values: ItemViewCategoriesList, ItemViewCategoriesList2 to ItemViewCategoriesList10. optional allowed values are ItemViewCategoriesList, ItemViewCategoriesList2, ItemViewCategoriesList3, ItemViewCategoriesList4, ItemViewCategoriesList5, ItemViewCategoriesList6, ItemViewCategoriesList7, ItemViewCategoriesList8, ItemViewCategoriesList9, ItemViewCategoriesList10"},"singleItemView":{"type":"string","description":"The template the category is linked to for the single item view. The template determines the appearance of the single item design for this category. This option is available for categories of the type Item only. Possible values: ItemViewSingleItem, ItemViewSingleItem2 to ItemViewSingleItem5. optional allowed values are ItemViewSingleItem, ItemViewSingleItem2, ItemViewSingleItem3, ItemViewSingleItem4, ItemViewSingleItem5"},"pageView":{"type":"string","description":"optional allowed values are PageDesignContent, PageDesignCheckout, PageDesignCustom, PageDesignCustom2, PageDesignCustom3"},"fulltext":{"type":"boolean","description":"Flag that indicates if the complete category text, i.e. the complete description, will be searched.Y = Complete text will be searched.N = Text will not be searched completely. optional allowed values are Y, N"},"metaRobots":{"type":"string","description":"Values from the meta element Robots are analyzed by Web crawlers. These values tell the crawler what it should do with the page and with the links on the page.all = Include this category in the search engine index and follow the links on the page.index = Include in the search engine index.nofollow = Do not follow the links on the page.noindex = Do not include in the search engine index.nofollow, noindex = Do not follow the links and do not include the category in the search engine index. optional allowed values are ALL, INDEX, NOFOLLOW, NOINDEX, NOINDEX_NOFOLLOW"},"clients":{"type":"array","items":{"$ref":"#\/definitions\/CategoryClient"}},"elmarCategories":{"type":"array","items":{"$ref":"#\/definitions\/CategoryProperty"}},"categoryId":{"type":"integer","description":"The unique ID of the category optional"},"marketId":{"type":"number","description":"The unique ID of the referrer"},"value":{"type":"string","description":"The category of the referrer"}}}}]}},"\/rest\/categories\/{id}\/clients":{"delete":{"summary":"Deactivate availability for clients","description":"Deactivate availability for clients","tags":["Category"],"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"}]}},"\/rest\/categories\/{id}\/details":{"delete":{"summary":"Delete category details for the specified languages","description":"Delete category details for the specified languages","tags":["Category"],"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"},{"in":"body","name":"\/rest\/categories\/{id}\/details","schema":{"type":"object","properties":{"plentyId":{"type":"integer","description":"The unique plenty ID of the client (store) in which the category is visible. If a subcategory is linked to a client, its parent categories will be linked to this client as well."},"lang":{"type":"string","description":"The language of the category allowed values are en, de, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"}}}}]}},"\/rest\/categories\/{id}\/templates":{"delete":{"summary":"Delete a category template","description":"Deletes a category template. The ID of the category, the plenty ID of the client (store) and the language must be specified.","tags":["Category"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/CategoryTemplate"},"examples":{"application\/json":{"categoryId":8,"plentyId":1000,"lang":"ka"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/categories\/{id}\/templates","schema":{"type":"object","properties":{"categoryId":{"type":"integer","description":"The unique ID of the category"},"plentyId":{"type":"integer","description":"The unique plenty ID of the client (store)"},"lang":{"type":"string","description":"The language of the template optional"}}}}]},"get":{"summary":"Get a category template","description":"Gets a category template. The ID of the category, the plenty ID of the client (store) and the language must be specified.","tags":["Category"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/CategoryTemplate"},"examples":{"application\/json":{"categoryId":3,"plentyId":1000,"lang":"dz"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 <a href='https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#countries' target='_blank'>language<\/a> of the template. If no language filter is set, the default language of the system is used.","format":"string","in":"query"},{"name":"plentyId","type":"integer","required":true,"description":"The unique plenty ID of the client (store)","format":"integer","in":"query"},{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"in":"body","name":"\/rest\/categories\/{id}\/templates","schema":{"type":"object","properties":{"categoryId":{"type":"integer","description":"The unique ID of the category"},"plentyId":{"type":"integer","description":"The unique plenty ID of the client (store)"},"lang":{"type":"string","description":"The language of the template optional"}}}}]},"put":{"summary":"Update a category template","description":"Updates a category template. The ID of the category, the plenty ID of the client (store) and the language must be specified.","tags":["Category"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/CategoryTemplate"},"examples":{"application\/json":{"categoryId":3,"plentyId":1000,"lang":"af"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/categories\/{id}\/templates","schema":{"type":"object","properties":{"categoryId":{"type":"integer","description":"The unique ID of the category"},"plentyId":{"type":"integer","description":"The unique plenty ID of the client (store)"},"lang":{"type":"string","description":"The language of the template optional"},"content":{"type":"string","description":"The content of the template"}}}}]}},"\/rest\/category_branches":{"get":{"summary":"Get category trees","description":"Gets category trees.","tags":["Category"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PaginationResponse"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"type","type":"string","required":false,"description":"The category type. Available values: item, container, content, blog ","format":"string","in":"query"}]}},"\/rest\/category_branches\/{id}":{"get":{"summary":"Get category tree","description":"Gets the category tree of a category. The ID of the category must be specified.","tags":["Category"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/CategoryBranch"},"examples":{"application\/json":{"categoryId":8,"category1Id":5,"category2Id":9,"category3Id":6,"category4Id":3,"category5Id":7,"category6Id":8}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 unique category ID","format":"integer","in":"path"}]}},"\/rest\/check_password":{"post":{"summary":"Check password","description":"Checks the credentials.","tags":["Authentication"],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/mixed"}}}}},"\/rest\/check_pin":{"post":{"summary":"Check given pin","description":"Checks the credentials.","tags":["Authentication"],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/mixed"}}}}},"\/rest\/comments":{"post":{"summary":"Create a comment","description":"Creates a new comment.","tags":["Comment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Comment"},"examples":{"application\/json":{"referenceValue":534,"userId":null,"createdAt":"2025-08-31T12:46:59+02:00","text":"Et aperiam qui adipisci perferendis omnis a hic autem tenetur corporis distinctio.","referenceType":"item_variation","isVisibleForContact":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/comments","schema":{"type":"object","properties":{"referenceType":{"type":"string","description":"The reference type. Valid types are:\n\n category\n contact\n order\n item_variation\n order_item\n allowed values are category, contact, order, register_incoming_items, item_variation, order_item"},"referenceValue":{"type":"integer","description":"The reference value"},"userId":{"type":"integer","description":"The ID of the user"},"text":{"type":"string","description":"The comment text"},"isVisibleForContact":{"type":"boolean","description":"If true, the comment is visible for the associated contact."}}}}]}},"\/rest\/comments\/{commentId}":{"delete":{"summary":"Delete a comment","description":"Deletes a comment. The ID of the comment must be specified.","tags":["Comment"],"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":"commentId","type":"integer","required":true,"description":"The ID of the comment","format":"integer","in":"path"}]},"get":{"summary":"Get a comment","description":"Gets a comment. The ID of the comment must be specified.","tags":["Comment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Comment"},"examples":{"application\/json":{"referenceValue":763,"userId":14,"createdAt":"2025-08-24T08:48:01+02:00","text":"Est corrupti voluptas eum eum ad deleniti cumque at optio doloribus.","referenceType":"item_variation","isVisibleForContact":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"commentId","type":"integer","required":true,"description":"The ID of the comment","format":"integer","in":"path"}]},"put":{"summary":"Update a comment","description":"Updates a comment by commentId.","tags":["Comment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Comment"},"examples":{"application\/json":{"referenceValue":348,"userId":null,"createdAt":"2025-09-09T21:16:11+02:00","text":"Porro dolores rerum cupiditate sit omnis fugiat error temporibus assumenda iste eos et.","referenceType":"order","isVisibleForContact":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"commentId","type":"integer","required":true,"description":"The ID of the comment","format":"integer","in":"path"},{"name":"referenceType","type":"string","required":true,"description":"The reference type. Valid types are 'category', 'contact', 'order'.","format":"string","in":"query"},{"name":"referenceValue","type":"integer","required":true,"description":"The reference value","format":"integer","in":"query"},{"name":"userId","type":"integer","required":false,"description":"The ID of the user the comment belongs to","format":"integer","in":"query"},{"name":"isVisibleForContact","type":"boolean","required":false,"description":"If true, the comment is visible for the associated contact.","format":"boolean","in":"query"}]}},"\/rest\/comments\/{referenceType}\/{referenceValue}":{"get":{"summary":"List comments","description":"Lists comments. 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":["Comment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/Comment"}},"examples":{"application\/json":[{"referenceValue":364,"userId":15,"createdAt":"2025-08-18T07:58:23+02:00","text":"Porro beatae qui odit laudantium nulla eligendi ut commodi at molestiae.","referenceType":"order_item","isVisibleForContact":false},{"referenceValue":702,"userId":16,"createdAt":"2025-08-15T07:11:36+02:00","text":"Doloribus dicta qui nesciunt autem eos rerum.","referenceType":"contact","isVisibleForContact":false}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":true,"description":"The reference type. Valid types are 'category', 'contact', 'order', 'order_item'.","format":"string","in":"path"},{"name":"referenceValue","type":"integer","required":true,"description":"The reference value","format":"integer","in":"path"},{"name":"userId","type":"integer","required":false,"description":"The ID of the user the comment belongs to","format":"integer","in":"query"},{"name":"isVisibleForContact","type":"boolean","required":false,"description":"If true, the comment is visible for the associated contact.","format":"boolean","in":"query"}]}},"\/rest\/conversations":{"delete":{"summary":"Deletes a batch of conversations","description":"Deletes a batch of conversations (soft delete, conversations will be moved to trash)","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"uuids","type":"array","required":true,"description":"The list of conversations UUID's to be deleted. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]},"get":{"summary":"List conversation based on provided parameters","description":"List conversation based on provided parameters","tags":["Messenger"],"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":"page","type":"integer","required":false,"description":"The page number (defaults to 1).","format":"integer","in":"query"},{"name":"itemsPerPage","type":"integer","required":false,"description":"The number of results per page (defaults to 50).","format":"integer","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"The sorting column (defaults to createdAt).","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"The sorting direction (defaults to desc).","format":"string","in":"query"},{"name":"title","type":"string","required":false,"description":"Filter results by conversation title (searched string must be contained in title).","format":"string","in":"query"},{"name":"message","type":"string","required":false,"description":"Filter results by message body (searched string must be contained in one of the converesation messages).","format":"string","in":"query"},{"name":"fromDate","type":"string","required":false,"description":"Filter results by conversation creation date. Conversation must be created after this date. Expected format: 2023-01-31T00:00:00+03:00","format":"string","in":"query"},{"name":"toDate","type":"string","required":false,"description":"Filter results by conversation creation date. Conversation must be created before this date. Expected format: 2023-01-31T00:00:00+03:00","format":"string","in":"query"},{"name":"updateFromDate","type":"string","required":false,"description":"Filter results by conversation update date. Conversation must be updated after this date. Expected format: 2023-01-31T00:00:00+03:00","format":"string","in":"query"},{"name":"updateToDate","type":"string","required":false,"description":"Filter results by conversation update date. Conversation must be updated before this date. Expected format: 2023-01-31T00:00:00+03:00","format":"string","in":"query"},{"name":"tagIds","type":"string","required":false,"description":"Filter results by conversation tags. Multiple values can be provided, separated by comma. Expected format: 1, 9, 15","format":"string","in":"query"},{"name":"isDone","type":"boolean","required":false,"description":"Filter results by conversation state. Expected values: true\/false","format":"boolean","in":"query"},{"name":"referrer","type":"string","required":false,"description":"Filter results by conversation referrer (referrer of first message of the conversation). Expected values: system\/backend\/rest\/plugin\/email","format":"string","in":"query"},{"name":"shortId","type":"integer","required":false,"description":"Filter results by conversation short ID.","format":"integer","in":"query"},{"name":"hasAttachments","type":"boolean","required":false,"description":"Filter results by conversation that contain at least one message with one attachment. Expected values: true","format":"boolean","in":"query"},{"name":"hasBilledMsg","type":"boolean","required":false,"description":"Filter results by conversation that contain at least one billed message. Expected values: true","format":"boolean","in":"query"},{"name":"orderIds","type":"string","required":false,"description":"Filter results by conversation relation type order. Multiple values can be provided, separated by comma. Expected format: 1, 9, 15","format":"string","in":"query"},{"name":"contactIds","type":"string","required":false,"description":"Filter results by conversation relation type contact. Multiple values can be provided, separated by comma. Expected format: 1, 9, 15","format":"string","in":"query"},{"name":"emails","type":"string","required":false,"description":"Filter results by conversation relation type email. Multiple values can be provided, separated by comma. Expected format: email1@plentymarkets.com, email2@plentymarkets.com","format":"string","in":"query"},{"name":"paymentIds","type":"string","required":false,"description":"Filter results by conversation relation type payment. Multiple values can be provided, separated by comma. Expected format: 1, 9, 15","format":"string","in":"query"},{"name":"subscribersUsers","type":"string","required":false,"description":"Filter results by conversation subscribers. Multiple values can be provided, separated by comma. Expected format: 1, 9, 15","format":"string","in":"query"},{"name":"fromValue","type":"string","required":false,"description":"Filter results by conversation sender (sender of the first message of tehr conversation).\n * The searched value can be and user ID or an email. Multiple values can be provided, separated by comma. This filter only works if the fromType filter is also provided. Expected format: 1, 5","format":"string","in":"query"},{"name":"fromType","type":"string","required":false,"description":"Filter results by conversation sender type (sender type of the first message of the conversation). Expected values: user\/email","format":"string","in":"query"},{"name":"priorityId","type":"integer","required":false,"description":"Filter results by conversation priority. Expected values: 1\/2\/3\/4\/5","format":"integer","in":"query"},{"name":"inboxId","type":"integer","required":false,"description":"Filter results by conversation inbox ID. Expected format: 1","format":"integer","in":"query"},{"name":"deadline","type":"string","required":false,"description":"Filter results by conversation deadline ID. Expected values: yesterday\/today\/tomorrow\/exceeded\/in_the_future","format":"string","in":"query"},{"name":"statusId","type":"integer","required":false,"description":"Filter results by conversation status ID","format":"integer","in":"query"},{"name":"typeId","type":"integer","required":false,"description":"Filter results by conversation type ID","format":"integer","in":"query"},{"name":"isDeleted","type":"integer","required":false,"description":"Filter results by conversation deleted flag. Expected values: 0\/1","format":"integer","in":"query"},{"name":"deletedAtBefore","type":"string","required":false,"description":"Filter results by conversation deleted date. Conversation must be deleted before this date. Expected format: 2023-01-31T00:00:00+03:00","format":"string","in":"query"},{"name":"isArchived","type":"string","required":false,"description":"Filter results from main index or from archive. Expected value: true\/false (defaults to false)","format":"string","in":"query"},{"name":"isRead","type":"boolean","required":false,"description":"Filter results by conversation read status. This filter will take effect only in combination with readById filter. Expected value: true\/false","format":"boolean","in":"query"},{"name":"readById","type":"integer","required":false,"description":"Filter results by conversation read status for the provided user ID. This filter will take effect only in combination with isRead filter. Expected format: 1","format":"integer","in":"query"},{"name":"uuids","type":"string","required":false,"description":"Filter results by conversation ID's. Multiple values can be provided, separated by comma. Expected format: ee2be9db-82c0-441b-98cb-5e11e34b549e, 24810ce7-4b75-45d0-8610-7fb07ede0d86","format":"string","in":"query"},{"name":"folderId","type":"string","required":false,"description":"Filter results by folder ID. Expected format: ee2be9db-82c0-441b-98cb-5e11e34b549e","format":"string","in":"query"},{"name":"with","type":"array","required":false,"description":"Appends relations to conversations. Expected values: ['messages']","format":"","in":"query","items":{"type":"string"}},{"name":"owners","type":"string","required":false,"description":"Filter results by conversation owners. Multiple values can be provided, separated by comma. Expected format: 1, 9, 15","format":"string","in":"query"}]},"post":{"summary":"Create a new conversation","description":"Create a new conversation","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Conversation"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/conversations\/archive":{"put":{"summary":"Move multiple conversations to archive","description":"Move multiple conversations to archive","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"uuids","type":"array","required":true,"description":"The list of conversations UUID's to archive. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/archiveDelete":{"delete":{"summary":"Permanently delete a list of archived conversation","description":"Permanently delete a list of archived conversation. This will delete also the messages that belong to that conversation","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"uuids","type":"array","required":true,"description":"The list of conversations UUID's to restore from archive. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/archiveRestore":{"put":{"summary":"Restore multiple conversations from archive","description":"Restore multiple conversations from archive","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"uuids","type":"array","required":true,"description":"The list of conversations UUID's to restore from archive. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/batchRestoreConversations":{"put":{"summary":"Restore deleted conversations from trash","description":"Restore deleted conversations from trash","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"uuids","type":"array","required":true,"description":"The list of conversations UUID's to restore from trash. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/batch_update_conversations":{"put":{"summary":"Update batch of conversations","description":"Update batch of conversations","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Conversation"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/conversations\/categories":{"delete":{"summary":"Deletes a batch of categories","description":"Deletes a batch of categories","tags":["Messenger"],"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":"ids","type":"array","required":true,"description":"Array of conversation categories ID's. Expected values: [1, 2]","format":"","in":"query","items":{"type":"integer"}}]},"get":{"summary":"Returns a paginated result object will list of conversation categories","description":"Returns a paginated result object will list of conversation categories","tags":["Messenger"],"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 ConversationCategory","items":{"$ref":"#\/definitions\/ConversationCategory"}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 number (defaults to 1).","format":"integer","in":"query"},{"name":"itemsPerPage","type":"integer","required":false,"description":"The number of results per page (defaults to 50).","format":"integer","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"The sorting column (defaults to id). Expected values: id\/position","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"The sorting direction (defaults to asc).","format":"string","in":"query"},{"name":"isDeleted","type":"boolean","required":false,"description":"Filter results by deleted flag.","format":"boolean","in":"query"},{"name":"name","type":"string","required":false,"description":"Filter results by type name.","format":"string","in":"query"},{"name":"id","type":"integer","required":false,"description":"Filter results by type ID.","format":"integer","in":"query"}]},"post":{"summary":"Creates a new category","description":"Creates a new category","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationCategory"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/conversations\/categories\/createDefaultTypesAndStatuses\/{id}":{"post":{"summary":"Creates a list of default types and statuses for given category ID","description":"Creates a list of default types and statuses for given category ID","tags":["Messenger"],"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":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/conversations\/categories\/{id}":{"delete":{"summary":"Deletes a single category (soft delete, type will be flagged as deleted)","description":"Deletes a single category (soft delete, type will be flagged as deleted)","tags":["Messenger"],"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":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Retrieves a single category based on ID","description":"Retrieves a single category based on ID","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationCategory"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 an existing category","description":"Updates an existing category","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationCategory"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/conversations\/categories\/{id}\/status":{"put":{"summary":"Updates category status","description":"Updates category status","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationCategory"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/conversations\/close":{"put":{"summary":"Updates the state for a batch of conversations","description":"Updates the state for a batch of conversations","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"isClosed","type":"boolean","required":true,"description":"The new state of the conversation. Expected values: true\/false","format":"boolean","in":"query"},{"name":"uuids","type":"array","required":true,"description":"Array of conversations UUID's. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/deadline":{"put":{"summary":"Update deadline for a batch of conversations","description":"Update deadline for a batch of conversations","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"deadline","type":"string","required":true,"description":"The new deadline. Expected format: 2023\/01\/31","format":"string","in":"query"},{"name":"uuids","type":"array","required":true,"description":"The list of conversations UUID's to update deadline. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/emptyTrash":{"delete":{"summary":"Adds the empty trash command to a queue","description":"Adds the empty trash command to a queue. Emptying of the trash will happen sometime in the future, when the first worker is available to process the queue","tags":["Messenger"],"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."}}}},"\/rest\/conversations\/events":{"get":{"summary":"Returns a paginated result object will list of conversation events","description":"Returns a paginated result object will list of conversation events","tags":["Messenger"],"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 ConversationEvent","items":{"$ref":"#\/definitions\/ConversationEvent"}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 number (defaults to 1).","format":"integer","in":"query"},{"name":"itemsPerPage","type":"integer","required":false,"description":"The number of results per page (defaults to 50).","format":"integer","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"The sorting column (defaults to id). Expected values: any property of the event model","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"The sorting direction (defaults to asc).","format":"string","in":"query"},{"name":"id","type":"integer","required":false,"description":"Filter results by event ID.","format":"integer","in":"query"},{"name":"name","type":"string","required":false,"description":"Filter results by event name.","format":"string","in":"query"},{"name":"description","type":"string","required":false,"description":"Filter results by event description.","format":"string","in":"query"},{"name":"type","type":"string","required":false,"description":"Filter results by event type. Expected values: live \/ scheduled","format":"string","in":"query"},{"name":"filter","type":"string","required":false,"description":"Filter results by event filters. Expected values: conversation_age \/ conversation_deadline \/\n * conversation_from_user \/ conversation_priority \/ conversation_type_status \/ conversation_referrer_type \/ conversation_inbox \/ conversation_last_change \/\n * conversation_tag \/ conversation_guest_order \/ conversation_is_lead \/ conversation_is_opportunity \/ contact_client \/ contact_class \/ contact_type \/ contact_tag\n * contact_language","format":"string","in":"query"},{"name":"action","type":"string","required":false,"description":"Filter results by event actions. Expected values: add_reply \/ send_email \/ update_deadline \/\n * add_subscriber \/ change_priority \/ change_type_and_status \/ add_to_folder \/ remove_from_folder \/ add_tags \/ remove_tags\/ add_contact_tags\/ remove_contact_tags","format":"string","in":"query"},{"name":"trigger","type":"string","required":false,"description":"Filter results by event triggers. Expected values: new_conversation \/ new_reply_to_conversation \/\n * new_email_from_customer \/ new_reply_from_customer \/ conversation_deadline_changed \/ conversation_priority_changed \/ conversation_status_changed \/\n * conversation_tag_added \/ conversation_tag_removed \/ conversation_scheduled_event","format":"string","in":"query"},{"name":"state","type":"boolean","required":false,"description":"Filter results by event state. Expected values: ntrue \/ false","format":"boolean","in":"query"}]},"post":{"summary":"Creates a new event","description":"Creates a new event","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationEvent"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/conversations\/events\/{id}":{"delete":{"summary":"Deletes a single event","description":"Deletes a single event","tags":["Messenger"],"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":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Updates an existing event","description":"Updates an existing event","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationEvent"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/conversations\/events\/{id}\/copy":{"put":{"summary":"Copies an event to a new event","description":"Copies an event to a new event","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationEvent"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":true,"description":"The name of the new event","format":"string","in":"query"},{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/conversations\/events\/{id}\/updateExecutedAtEvent":{"put":{"summary":"Sets the last execution date for an existing event","description":"Sets the current date as the last execution date for an existing event","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationEvent"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/conversations\/events\/{id}\/update_status":{"put":{"summary":"Sets an event as active \/ inactive","description":"Sets an event as active \/ inactive","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationEvent"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"status","type":"boolean","required":true,"description":"The new status. Expected values: true\/false","format":"boolean","in":"query"},{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/conversations\/folders":{"get":{"summary":"Returns a paginated result object will list of folders","description":"Returns a paginated result object will list of folders","tags":["Messenger"],"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 ConversationFolder","items":{"$ref":"#\/definitions\/ConversationFolder"}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 number (defaults to 1).","format":"integer","in":"query"},{"name":"itemsPerPage","type":"integer","required":false,"description":"The number of results per page (defaults to 50).","format":"integer","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"The sorting column (defaults to name). Expected values: any folder model property","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"The sorting direction (defaults to asc).","format":"string","in":"query"},{"name":"userId","type":"integer","required":false,"description":"Filter results by user ID (defaults to null, all users).","format":"integer","in":"query"}]},"post":{"summary":"Creates a new folder","description":"Creates a new folder. Important! The userId property will be automatically set based on the current logged in user.","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationFolder"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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":"Assigns a batch of conversations to a batch of folders","description":"Assigns a batch of conversations to a batch of folders","tags":["Messenger"],"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":"foldersUuids","type":"integer","required":true,"description":"The list of folders to be assigned to. Expected format: ['78656f7d-02fd-5461-9e54-13b2668f9b43']","format":"integer","in":"query"},{"name":"conversationsUuids","type":"array","required":true,"description":"The list of conversations UUID's to assign to folders. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/folders\/add":{"put":{"summary":"Add multiple conversations to multiple folders","description":"Add multiple conversations to multiple folders","tags":["Messenger"],"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":"foldersUuids","type":"integer","required":true,"description":"The list of folders to be assigned to. Expected format: ['78656f7d-02fd-5461-9e54-13b2668f9b43']","format":"integer","in":"query"},{"name":"conversationsUuids","type":"array","required":true,"description":"The list of conversations UUID's to assign to folders. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/folders\/remove":{"put":{"summary":"Remove multiple conversations from multiple folders","description":"Remove multiple conversations from multiple folders","tags":["Messenger"],"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":"foldersUuids","type":"integer","required":true,"description":"The list of folders that will be removed from the conversation. Expected format: ['78656f7d-02fd-5461-9e54-13b2668f9b43']","format":"integer","in":"query"},{"name":"conversationsUuids","type":"array","required":true,"description":"The list of conversations UUID's to assign to folders. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/folders\/{uuid5}":{"delete":{"summary":"Deletes a folder","description":"Deletes a folder","tags":["Messenger"],"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":"uuid5","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Retrieves a folder object based on UUID","description":"Retrieves a folder object based on UUID","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationFolder"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]},"put":{"summary":"Updates an existing folder","description":"Updates an existing folder","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationFolder"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/conversations\/followUpDate":{"put":{"summary":"Update follow up date for a batch of conversations","description":"Update follow up date for a batch of conversations","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"followUpDate","type":"string","required":true,"description":"The new follow up date. Expected format: 2023\/01\/31","format":"string","in":"query"},{"name":"uuids","type":"array","required":true,"description":"The list of conversations UUID's to update deadline. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/history\/{uuid5}":{"get":{"summary":"Retrieves history for a conversation","description":"Retrieves history for a conversation","tags":["Messenger"],"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":"uuid5","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/conversations\/inboxes":{"get":{"summary":"Returns a list with all configured inboxes","description":"Returns a list with all configured inboxes (only active ones)","tags":["Messenger"],"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\/conversations\/markNotSpam":{"put":{"summary":"Mark a batch of conversations as read or unread","description":"Mark a batch of conversations as read or unread","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"uuids","type":"array","required":true,"description":"The list of conversations UUID's to update read status. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/owner":{"put":{"summary":"Update owner roles for specific conversation id\/ids","description":"Update owner roles for specific conversation id\/ids","tags":["Messenger"],"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."}}}},"\/rest\/conversations\/priority":{"put":{"summary":"Updates priority for a batch of conversations","description":"Updates priority for a batch of conversations","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"priorityId","type":"integer","required":true,"description":"The new priority. Expected values: 0\/1\/2\/3\/4\/5","format":"integer","in":"query"},{"name":"uuids","type":"array","required":true,"description":"The list of conversations UUID's to update priority. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/read":{"put":{"summary":"Mark a batch of conversations as read or unread","description":"Mark a batch of conversations as read or unread","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"read","type":"boolean","required":true,"description":"The read status. Expected values: true\/false","format":"boolean","in":"query"},{"name":"userId","type":"integer","required":true,"description":"The user ID for which the conversations will be marked as read\/unread. Expected format: 1","format":"integer","in":"query"},{"name":"uuids","type":"array","required":true,"description":"The list of conversations UUID's to update read status. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/removeRelation":{"delete":{"summary":"Remove conversation relation","description":"Remove conversation relation","tags":["Messenger"],"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."}}}},"\/rest\/conversations\/roles":{"delete":{"summary":"Delete a batch of roles","description":"Delete a batch of roles","tags":["Messenger"],"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":"ids","type":"array","required":true,"description":"Array of conversation roles ID's. Expected values: [1, 2]","format":"","in":"query","items":{"type":"integer"}}]},"get":{"summary":"Returns a paginated result object with list of roles","description":"Returns a paginated result object with list of roles","tags":["Messenger"],"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 ConversationRole","items":{"$ref":"#\/definitions\/ConversationRole"}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 number (defaults to 1).","format":"integer","in":"query"},{"name":"itemsPerPage","type":"integer","required":false,"description":"The number of results per page (defaults to 50).","format":"integer","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"The sorting column (defaults to id). Expected values: id or position","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"The sorting direction (defaults to asc).","format":"string","in":"query"}]},"post":{"summary":"Create new role","description":"Crete new role","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationRole"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/conversations\/roles\/{id}":{"delete":{"summary":"Delete a role by ID","description":"Delete a role by ID","tags":["Messenger"],"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":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Retrieves a role object based on role id","description":"Retrieves a role object based on role id","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationRole"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 an existing role","description":"Updates an existing role","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationRole"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/conversations\/search":{"post":{"summary":"Search conversation based on provided parameters","description":"Search conversation based on provided parameters","tags":["Messenger"],"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":"page","type":"integer","required":false,"description":"The page number (defaults to 1).","format":"integer","in":"query"},{"name":"itemsPerPage","type":"integer","required":false,"description":"The number of results per page (defaults to 50).","format":"integer","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"The sorting column (defaults to createdAt).","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"The sorting direction (defaults to desc).","format":"string","in":"query"},{"name":"title","type":"string","required":false,"description":"Filter results by conversation title (searched string must be contained in title).","format":"string","in":"query"},{"name":"message","type":"string","required":false,"description":"Filter results by message body (searched string must be contained in one of the converesation messages).","format":"string","in":"query"},{"name":"fromDate","type":"string","required":false,"description":"Filter results by conversation creation date. Conversation must be created after this date. Expected format: 2023-01-31T00:00:00+03:00","format":"string","in":"query"},{"name":"toDate","type":"string","required":false,"description":"Filter results by conversation creation date. Conversation must be created before this date. Expected format: 2023-01-31T00:00:00+03:00","format":"string","in":"query"},{"name":"updateFromDate","type":"string","required":false,"description":"Filter results by conversation update date. Conversation must be updated after this date. Expected format: 2023-01-31T00:00:00+03:00","format":"string","in":"query"},{"name":"updateToDate","type":"string","required":false,"description":"Filter results by conversation update date. Conversation must be updated before this date. Expected format: 2023-01-31T00:00:00+03:00","format":"string","in":"query"},{"name":"tagIds","type":"string","required":false,"description":"Filter results by conversation tags. Multiple values can be provided, separated by comma. Expected format: 1, 9, 15","format":"string","in":"query"},{"name":"isDone","type":"boolean","required":false,"description":"Filter results by conversation state. Expected values: true\/false","format":"boolean","in":"query"},{"name":"referrer","type":"string","required":false,"description":"Filter results by conversation referrer (referrer of first message of the conversation). Expected values: system\/backend\/rest\/plugin\/email","format":"string","in":"query"},{"name":"shortId","type":"integer","required":false,"description":"Filter results by conversation short ID.","format":"integer","in":"query"},{"name":"hasAttachments","type":"boolean","required":false,"description":"Filter results by conversation that contain at least one message with one attachment. Expected values: true","format":"boolean","in":"query"},{"name":"hasBilledMsg","type":"boolean","required":false,"description":"Filter results by conversation that contain at least one billed message. Expected values: true","format":"boolean","in":"query"},{"name":"orderIds","type":"string","required":false,"description":"Filter results by conversation relation type order. Multiple values can be provided, separated by comma. Expected format: 1, 9, 15","format":"string","in":"query"},{"name":"contactIds","type":"string","required":false,"description":"Filter results by conversation relation type contact. Multiple values can be provided, separated by comma. Expected format: 1, 9, 15","format":"string","in":"query"},{"name":"emails","type":"string","required":false,"description":"Filter results by conversation relation type email. Multiple values can be provided, separated by comma. Expected format: email1@plentymarkets.com, email2@plentymarkets.com","format":"string","in":"query"},{"name":"paymentIds","type":"string","required":false,"description":"Filter results by conversation relation type payment. Multiple values can be provided, separated by comma. Expected format: 1, 9, 15","format":"string","in":"query"},{"name":"subscribersUsers","type":"string","required":false,"description":"Filter results by conversation subscribers. Multiple values can be provided, separated by comma. Expected format: 1, 9, 15","format":"string","in":"query"},{"name":"fromValue","type":"string","required":false,"description":"Filter results by conversation sender (sender of the first message of tehr conversation).\n * The searched value can be and user ID or an email. Multiple values can be provided, separated by comma. This filter only works if the fromType filter is also provided. Expected format: 1, 5","format":"string","in":"query"},{"name":"fromType","type":"string","required":false,"description":"Filter results by conversation sender type (sender type of the first message of the conversation). Expected values: user\/email","format":"string","in":"query"},{"name":"priorityId","type":"integer","required":false,"description":"Filter results by conversation priority. Expected values: 1\/2\/3\/4\/5","format":"integer","in":"query"},{"name":"inboxId","type":"integer","required":false,"description":"Filter results by conversation inbox ID. Expected format: 1","format":"integer","in":"query"},{"name":"deadline","type":"string","required":false,"description":"Filter results by conversation deadline ID. Expected values: yesterday\/today\/tomorrow\/exceeded\/in_the_future","format":"string","in":"query"},{"name":"statusId","type":"integer","required":false,"description":"Filter results by conversation status ID","format":"integer","in":"query"},{"name":"typeId","type":"integer","required":false,"description":"Filter results by conversation type ID","format":"integer","in":"query"},{"name":"isDeleted","type":"integer","required":false,"description":"Filter results by conversation deleted flag. Expected values: 0\/1","format":"integer","in":"query"},{"name":"deletedAtBefore","type":"string","required":false,"description":"Filter results by conversation deleted date. Conversation must be deleted before this date. Expected format: 2023-01-31T00:00:00+03:00","format":"string","in":"query"},{"name":"isArchived","type":"string","required":false,"description":"Filter results from main index or from archive. Expected value: true\/false (defaults to false)","format":"string","in":"query"},{"name":"isRead","type":"boolean","required":false,"description":"Filter results by conversation read status. This filter will take effect only in combination with readById filter. Expected value: true\/false","format":"boolean","in":"query"},{"name":"readById","type":"integer","required":false,"description":"Filter results by conversation read status for the provided user ID. This filter will take effect only in combination with isRead filter. Expected format: 1","format":"integer","in":"query"},{"name":"uuids","type":"string","required":false,"description":"Filter results by conversation ID's. Multiple values can be provided, separated by comma. Expected format: ee2be9db-82c0-441b-98cb-5e11e34b549e, 24810ce7-4b75-45d0-8610-7fb07ede0d86","format":"string","in":"query"},{"name":"folderId","type":"string","required":false,"description":"Filter results by folder ID. Expected format: ee2be9db-82c0-441b-98cb-5e11e34b549e","format":"string","in":"query"},{"name":"with","type":"array","required":false,"description":"Appends relations to conversations. Expected values: ['messages']","format":"","in":"query","items":{"type":"string"}},{"name":"owners","type":"string","required":false,"description":"Filter results by conversation owners. Multiple values can be provided, separated by comma. Expected format: 1, 9, 15","format":"string","in":"query"}]}},"\/rest\/conversations\/searchReceiver":{"get":{"summary":"Searches for entities that can be linked to a conversation","description":"Searches for entities that can be linked to a conversation. It will search for contacts (ID and full text), orders (ID) and users (name, email and ID)","tags":["Messenger"],"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":"searchTerm","type":"string","required":true,"description":"The searched value. Expected values: John Doe\/ 123 \/ john@plentymarkets.com","format":"string","in":"query"}]}},"\/rest\/conversations\/statuses":{"delete":{"summary":"Deletes a batch of statuses","description":"Deletes a batch of statuses","tags":["Messenger"],"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":"ids","type":"array","required":true,"description":"Array of conversation statuses ID's. Expected values: [1, 2]","format":"","in":"query","items":{"type":"integer"}}]},"get":{"summary":"Returns a paginated result object will list of conversation statuses","description":"Returns a paginated result object will list of conversation statuses","tags":["Messenger"],"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 ConversationStatus","items":{"$ref":"#\/definitions\/ConversationStatus"}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 number (defaults to 1).","format":"integer","in":"query"},{"name":"itemsPerPage","type":"integer","required":false,"description":"The number of results per page (defaults to 50).","format":"integer","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"The sorting column (defaults to id). Expected values: id\/position","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"The sorting direction (defaults to asc).","format":"string","in":"query"},{"name":"isDeleted","type":"boolean","required":false,"description":"Filter results by deleted flag.","format":"boolean","in":"query"},{"name":"name","type":"string","required":false,"description":"Filter results by status name.","format":"string","in":"query"},{"name":"id","type":"integer","required":false,"description":"Filter results by status ID.","format":"integer","in":"query"},{"name":"typeId","type":"integer","required":false,"description":"Filter results by status type ID.","format":"integer","in":"query"}]},"post":{"summary":"Creates a new status","description":"Creates a new status","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationStatus"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/conversations\/statuses\/{id}":{"delete":{"summary":"Deletes a single status","description":"Deletes a single status (soft delete, status will be flagged as deleted)","tags":["Messenger"],"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":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Retrieves a single status based on ID","description":"Retrieves a single status based on ID","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationStatus"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 an existing status","description":"Updates an existing status","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationStatus"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/conversations\/subscribe":{"put":{"summary":"Subscribes the current user to multiple conversations","description":"Subscribes the current user to multiple conversations","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"uuids","type":"array","required":true,"description":"The list of conversations UUID's to subscribe to. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/tags":{"put":{"summary":"Adds multiple tags to multiple conversations","description":"Adds multiple tags to multiple conversations","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"tagIds","type":"array","required":true,"description":"The list of tags to be added. Expected values: [17, 18]","format":"","in":"query","items":{"type":"integer"}},{"name":"uuids","type":"array","required":true,"description":"Array of conversations UUID's. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/totals":{"get":{"summary":"Returns the total number of unread conversations for current user","description":"Returns the total number of unread conversations for current user","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":{"totalUnread":123}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/conversations\/type_status":{"put":{"summary":"Updates type and status for a batch of conversations","description":"Updates type and status for a batch of conversations","tags":["Messenger"],"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":"typeId","type":"integer","required":true,"description":"The new type. Expected format: 1","format":"integer","in":"query"},{"name":"statusId","type":"integer","required":true,"description":"The new status. Expected format: 1","format":"integer","in":"query"},{"name":"uuids","type":"array","required":true,"description":"The list of conversations UUID's to update type and status. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/types":{"delete":{"summary":"Deletes a batch of types","description":"Deletes a batch of types","tags":["Messenger"],"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":"ids","type":"array","required":true,"description":"Array of conversation types ID's. Expected values: [1, 2]","format":"","in":"query","items":{"type":"integer"}}]},"get":{"summary":"Returns a paginated result object will list of conversation types","description":"Returns a paginated result object will list of conversation types","tags":["Messenger"],"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 ConversationType","items":{"$ref":"#\/definitions\/ConversationType"}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 number (defaults to 1).","format":"integer","in":"query"},{"name":"itemsPerPage","type":"integer","required":false,"description":"The number of results per page (defaults to 50).","format":"integer","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"The sorting column (defaults to id). Expected values: id\/position","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"The sorting direction (defaults to asc).","format":"string","in":"query"},{"name":"isDeleted","type":"boolean","required":false,"description":"Filter results by deleted flag.","format":"boolean","in":"query"},{"name":"name","type":"string","required":false,"description":"Filter results by type name.","format":"string","in":"query"},{"name":"id","type":"integer","required":false,"description":"Filter results by type ID.","format":"integer","in":"query"},{"name":"with","type":"array","required":false,"description":"Appends relations to types. Expected values: ['allStatuses'] \/ ['activeStatuses']","format":"","in":"query","items":{"type":"string"}}]},"post":{"summary":"Creates a new type","description":"Creates a new type","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationType"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/conversations\/types\/{id}":{"delete":{"summary":"Deletes a single type","description":"Deletes a single type (soft delete, type will be flagged as deleted)","tags":["Messenger"],"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":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Retrieves a single type based on ID","description":"Retrieves a single type based on ID","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationType"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 an existing type","description":"Updates an existing type","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationType"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/conversations\/unsubscribe":{"put":{"summary":"Unsubscribe the current user from multiple conversations","description":"Unsubscribe the current user from multiple conversations","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"uuids","type":"array","required":true,"description":"The list of conversations UUID's to unsubscribe from. Expected values: ['24810ce7-4b75-45d0-8610-7fb07ede0d86']","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/conversations\/{uuid5}":{"delete":{"summary":"Deletes a conversation","description":"Deletes a conversation (soft delete, conversation will be moved to trash)","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]},"get":{"summary":"Get a single conversation by UUID","description":"Get a single conversation by UUID","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Conversation"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]},"put":{"summary":"Updates a conversation by UUID","description":"Updates a conversation by UUID","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Conversation"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/conversations\/{uuid5}\/subscribe":{"put":{"summary":"Subscribes a user to a conversation","description":"Subscribes a user to a conversation","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"userId","type":"integer","required":true,"description":"The ID of the user to be subscribed. Expected format: 1","format":"integer","in":"query"},{"name":"uuid5","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/conversations\/{uuid5}\/tags":{"put":{"summary":"Adds tags to a single conversation","description":"Adds tags to a single conversation","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"tagIds","type":"array","required":true,"description":"The list of tags to be added. Expected values: [17, 18]","format":"","in":"query","items":{"type":"integer"}},{"name":"uuid5","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/conversations\/{uuid5}\/unsubscribe":{"put":{"summary":"Unsubscribes a user from a conversation","description":"Unsubscribes a user from a conversation","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"userId","type":"integer","required":true,"description":"The ID of the user to be unsubscribed. Expected format: 1","format":"integer","in":"query"},{"name":"uuid5","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/credit_notes":{"post":{"summary":"Create a credit note","description":"Creates a credit note.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":7,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/credit_notes\/items\/{orderItemId}\/assign_variation":{"post":{"summary":"Change an order item of type \"unassigned variation\" to \"variation\".","description":"Change an order item of type \"unassigned variation\" to \"variation\". The ID of the order item and variation ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":8,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/credit_notes\/items\/{orderItemId}\/unassign_variation":{"post":{"summary":"Change an order item of type \"variation\" to \"unassigned variation\".","description":"Change an order item of type \"variation\" to \"unassigned variation\". The ID of the order item must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":9,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/credit_notes\/preview":{"post":{"summary":"Get a credit note create preview.","description":"Returns a credit note preview for the given order data without creating a credit note.","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\/credit_notes\/reasons":{"get":{"summary":"Get all order credit note reasons","description":"Gets all order credit note reasons.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/CreditNoteReason"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 an order credit note reason","description":"Sets an order credit note reason.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/CreditNoteReason"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/credit_notes\/reasons\/{creditNotesReasonsId}":{"delete":{"summary":"Delete an order credit note reason","description":"Deletes an order credit note reason. The credit note reason 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":"creditNotesReasonsId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get an order credit note reason","description":"Gets an order credit note reason. The credit note reason has to be specified by providing a credit note reason\nID.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/CreditNoteReason"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"creditNotesReasonsId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/credit_notes\/{orderId}":{"delete":{"summary":"Delete a credit note","description":"Deletes a credit note. 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 credit note","description":"Updates a credit note. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":5,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/credit_notes\/{orderId}\/preview":{"put":{"summary":"Get a credit note update preview","description":"Returns a credit note preview for the given order data without updating a credit note. The order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/credit_notes\/{orderId}\/restore":{"post":{"summary":"Restore a credit note","description":"Restores a deleted credit note. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":4,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/delete_log":{"get":{"summary":"Search the delete log","description":"Searches the delete log.","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 DeleteLog","items":{"$ref":"#\/definitions\/DeleteLog"}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"integer","required":false,"description":"The type of deleted record","format":"integer","in":"query"},{"name":"userId","type":"integer","required":false,"description":"The ID of the user who deleted the record","format":"integer","in":"query"},{"name":"updatedBetween","type":"string","required":false,"description":"Filter restricts the list of results to deleteLogs 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, ...\/delete_log?updatedBetween=1451606400,1456790400 will list deleteLogs updated between 2016-01-01 and 2016-03-01. ...\/delete_log?updatedBetween=1451606400 will list deleteLogs updated since 2016-01-01. The PHP function strtotime is also supported.","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"}]}},"\/rest\/delivery_orders":{"post":{"summary":"Create a delivery order","description":"Creates a new delivery order.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":5,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/delivery_orders\/items\/{orderItemId}\/assign_variation":{"post":{"summary":"Change an order item of type \"unassigned variation\" to \"variation\".","description":"Change an order item of type \"unassigned variation\" to \"variation\". The ID of the order item and variation ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":7,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/delivery_orders\/items\/{orderItemId}\/unassign_variation":{"post":{"summary":"Change an order item of type \"variation\" to \"unassigned variation\".","description":"Change an order item of type \"variation\" to \"unassigned variation\". The ID of the order item must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":9,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/delivery_orders\/preview":{"post":{"summary":"Get a delivery order create preview.","description":"Returns a delivery order preview for the given order data without creating a delivery order.","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\/delivery_orders\/{orderId}":{"delete":{"summary":"Delete a delivery order","description":"Deletes a delivery order. 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 delivery order","description":"Updates a delivery order. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":9,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/delivery_orders\/{orderId}\/book":{"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","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"},{"in":"body","name":"\/rest\/delivery_orders\/{orderId}\/book","schema":{"type":"object","properties":{"message":{"type":"string","description":""},"bookingDate":{"type":"string","description":""}}}}]}},"\/rest\/delivery_orders\/{orderId}\/cancel_booking":{"post":{"summary":"Revert outgoing stock","description":"Cancellation the booking of an order. The ID of the order must be specified. With the array 'quantities' the items to cancel can be defined. If 'quantities' is not given, the whole order will be cancelled and the booking date will be deleted. If 'quantities' is defined, the booking date won't be reset.","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"},{"in":"body","name":"\/rest\/delivery_orders\/{orderId}\/cancel_booking","schema":{"type":"object","properties":{"changeStatus":{"type":"boolean","description":""},"quantities":{"type":"array","items":{}}}}}]}},"\/rest\/delivery_orders\/{orderId}\/cancel_booking\/validate":{"post":{"summary":"Validate cancellation of the booking of an order","description":"Validates cancellation of the booking 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\/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":"","format":"integer","in":"path"}]}},"\/rest\/delivery_orders\/{orderId}\/preview":{"put":{"summary":"Get a delivery order update preview","description":"Returns a delivery order preview for the given order data without updating a delivery order. The order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/documents\/generation\/settings":{"get":{"summary":"","description":"","tags":[""],"responses":{"200":{"description":"OK"}}},"put":{"summary":"","description":"","tags":[""],"responses":{"200":{"description":"OK"}}}},"\/rest\/documents\/incoming_items_receipt\/generate":{"post":{"summary":"Generate a document of an \"stockIntake\".","description":"Generates a receipt that contains a least information about a stockIntake.\nTherefore at least the \"receiptId\" 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."}}}},"\/rest\/documents\/incoming_items_receipt\/generate\/preview":{"post":{"summary":"Generates a preview of the \"incoming items receipt\".","description":"Currently only supports generating the document as html.","tags":["Document"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/StockIntakeDocumentGenerationPreview"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/documents\/preview\/generate\/{previewType}":{"post":{"summary":"Generate a preview of a document","description":"Generates a preview of a document. The type of the preview must be specified.","tags":["Document"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DocumentGenerationPreview"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"previewType","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/documents\/preview\/{documentHash}":{"get":{"summary":"Download the content of a preview document","description":"Download the content of a preview document. The hash 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":"documentHash","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/documents\/{documentId}":{"get":{"summary":"Download the content of a document","description":"Downloads the content of a document. The ID 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":"documentId","type":"integer","required":true,"description":"The ID of the document","format":"integer","in":"path"}]}},"\/rest\/documents\/{documentId}\/regenerate":{"post":{"summary":"Regenerate a faulty document","description":"Regenerate a faulty document. The ID of the document must be specified.","tags":["Document"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DocumentGeneration"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"documentId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/documents\/{documentId}\/status":{"get":{"summary":"Get status of a document","description":"Get status of a document. The ID of the document must be specified.","tags":["Document"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DocumentGeneration"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"documentId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/cleanup\/old-files":{"post":{"summary":"Start cron to clean up old files","description":"Starts cron to clean up old files","tags":["Sync"],"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\/elastic-sync\/document":{"get":{"summary":"Get a single storage object from sync documents","description":"Gets a single storage object from sync documents","tags":["Sync"],"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 of the object to get from sync documents.","format":"string","in":"query"}]},"post":{"summary":"Upload a document to sync directory","description":"Uploads a document to sync directory","tags":["Sync"],"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","format":"string","in":"query"}]}},"\/rest\/elastic-sync\/document\/url":{"get":{"summary":"Get a temporary url for a single document","description":"Gets a temporary url for a single document","tags":["Sync"],"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 to get temporary url for","format":"string","in":"query"}]}},"\/rest\/elastic-sync\/documents":{"delete":{"summary":"Delete files from sync documents","description":"Deletes files from sync documents","tags":["Sync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/SimpleRestResponse"},"examples":{"application\/json":{"contentType":"Bool","contentLength":4,"content":"true"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":true,"description":"List of storage keys to delete","format":"","in":"query","items":{"type":"string"}}]},"get":{"summary":"List documents for a single sync","description":"Lists documents for a single sync","tags":["Sync"],"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 from previous request to continue listing documents","format":"string","in":"query"}]}},"\/rest\/elastic-sync\/mapping\/csv-rows\/{syncId}":{"get":{"summary":"Get the csv rows.","description":"Gets the csv rows. Sync ID is required.","tags":["ElasticSync"],"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":"syncId","type":"integer","required":true,"description":"The id of the sync","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/mapping\/fields\/{syncType}":{"get":{"summary":"Get the plenty fields value map for a particular sync type.","description":"Gets the plenty fields value map for a particular sync type. Sync type is required.","tags":["ElasticSync"],"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":"syncType","type":"string","required":true,"description":"The sync type","format":"string","in":"path"}]}},"\/rest\/elastic-sync\/mapping\/filter\/labels":{"get":{"summary":"Get the label list for mapping filtration.","description":"Gets the label list for mapping filtration.","tags":["ElasticSync"],"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\/elastic-sync\/mapping\/map\/csv-columns\/{syncId}":{"get":{"summary":"Get the csv columns of a sync.","description":"Gets the csv columns of a sync. Sync ID is required.","tags":["ElasticSync"],"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":"syncId","type":"integer","required":true,"description":"The sync id of the mapping","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/mapping\/map\/tree":{"get":{"summary":"Get the mapping values tree.","description":"Gets the mapping values. Sync data type is required.","tags":["ElasticSync"],"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\/elastic-sync\/mapping\/model\/{syncType}":{"get":{"summary":"Get the model key to field value key.","description":"Gets the model key to field value key. Sync type is required.","tags":["ElasticSync"],"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":"syncType","type":"string","required":true,"description":"The sync type","format":"string","in":"path"}]}},"\/rest\/elastic-sync\/mapping\/values\/{syncType}":{"get":{"summary":"Get the mapping values.","description":"Gets the mapping values. Sync data type is required.","tags":["ElasticSync"],"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":"sync_type","type":"string","required":true,"description":"The sync type","format":"string","in":"query"},{"name":"syncType","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/mapping\/variation":{"get":{"summary":"Get a list with variation matches.","description":"Get a list with variation matches.","tags":["ElasticSync"],"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\/elastic-sync\/sync":{"post":{"summary":"Create a sync.","description":"Creates a sync. The name, sync type, source type and source data type must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncSync"},"examples":{"application\/json":{"name":"Non officia nulla.","syncType":"warehouse","sourceType":"http","sourceDataType":"csv","lastRun":"-0001-11-30T00:00:00+00:53"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/elastic-sync\/sync\/change-csv":{"put":{"summary":"Update the Csv of a Sync.","description":"Update the Csv of a Sync. The ID of the sync must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncSync"},"examples":{"application\/json":{"name":"Molestiae nemo.","syncType":"warehouse","sourceType":"http","sourceDataType":"csv","lastRun":"-0001-11-30T00:00:00+00:53"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/elastic-sync\/sync\/import":{"post":{"summary":"Save the CSV on S3.","description":"Saves the CSV on S3.","tags":["ElasticSync"],"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":"file","type":"array","required":true,"description":"The file data","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/elastic-sync\/sync\/import-different":{"post":{"summary":"Import the sync with different plentyId.","description":"Imports the sync with different plentyId.","tags":["ElasticSync"],"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":"file","type":"array","required":true,"description":"The file data","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/elastic-sync\/sync\/import\/file\/public-url":{"post":{"summary":"Save the CSV on S3.","description":"Saves the CSV on S3.","tags":["ElasticSync"],"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":"file","type":"array","required":true,"description":"The file data","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/elastic-sync\/sync\/import\/file\/public-url\/different":{"post":{"summary":"Import the sync with different plentyId.","description":"Imports the sync with different plentyId.","tags":["ElasticSync"],"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":"file","type":"array","required":true,"description":"The file data","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/elastic-sync\/sync\/intervals":{"get":{"summary":"Get list of sync intervals.","description":"Gets list of sync intervals.","tags":["ElasticSync"],"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\/elastic-sync\/sync\/mapping\/filter\/{filterId}":{"delete":{"summary":"Delete a sync mapping.","description":"Deletes a sync mapping. The ID of the sync mapping must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMappingFilter"},"examples":{"application\/json":{"mappingId":1,"type":"contains","operator":1,"source":"CategoryLevel3Name","value":"2"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"filterId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get a sync mapping.","description":"Gets a sync mapping. The ID of the sync mapping must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMappingFilter"},"examples":{"application\/json":{"mappingId":1,"type":"contains","operator":1,"source":"CategoryLevel3Name","value":"2"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"filterId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Update a sync mapping filter.","description":"Updates a sync mapping filter. The ID of the sync mapping must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMappingFilter"},"examples":{"application\/json":{"mappingId":1,"type":"contains","operator":1,"source":"CategoryLevel3Name","value":"2"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"filterId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/mapping\/row\/{rowId}":{"delete":{"summary":"Delete a sync mapping row.","description":"Deletes a sync mapping row. The ID of the sync mapping row must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMappingRow"},"examples":{"application\/json":{"mappingId":1,"targetModel":"Magni eius fuga ut.","targetAttribute":"Sit animi aut id.","active":0,"entityType":"source","value":"variation_number","settings":"","identifiers":""}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"rowId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get a sync mapping row.","description":"Gets a sync mapping row. The ID of the sync mapping row must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMappingRow"},"examples":{"application\/json":{"mappingId":1,"targetModel":"Suscipit dolor cum.","targetAttribute":"Sit fugiat vitae.","active":1,"entityType":"source","value":"variation_number","settings":"","identifiers":""}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"rowId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Update a sync mapping row.","description":"Updates a sync mapping row. The ID of the sync mapping row must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMappingRow"},"examples":{"application\/json":{"mappingId":1,"targetModel":"Est tenetur.","targetAttribute":"Architecto eos.","active":0,"entityType":"source","value":"variation_number","settings":"","identifiers":""}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"rowId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/mapping\/{mappingId}":{"delete":{"summary":"Delete a sync mapping.","description":"Deletes a sync mapping. The ID of the sync mapping must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMapping"},"examples":{"application\/json":{"syncId":1,"name":"Fuga dolore autem.","position":8,"active":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"mappingId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get a sync mapping.","description":"Gets a sync mapping. The ID of the sync mapping must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMapping"},"examples":{"application\/json":{"syncId":1,"name":"Maiores non.","position":7,"active":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"mappingId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Update a sync mapping.","description":"Updates a sync mapping. The ID of the sync mapping must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMapping"},"examples":{"application\/json":{"syncId":1,"name":"Natus provident.","position":17,"active":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"mappingId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/mapping\/{mappingId}\/filter":{"post":{"summary":"Create a sync mapping filter.","description":"Creates a sync mapping filter.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMappingFilter"},"examples":{"application\/json":{"mappingId":1,"type":"contains","operator":1,"source":"CategoryLevel3Name","value":"2"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"mappingId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/mapping\/{mappingId}\/filters":{"get":{"summary":"List sync mappings.","description":"Lists sync mappings.","tags":["ElasticSync"],"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":"mappingId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"post":{"summary":"Create sync mapping filters.","description":"Creates sync mapping filters.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMappingFilter"},"examples":{"application\/json":{"mappingId":1,"type":"contains","operator":1,"source":"CategoryLevel3Name","value":"2"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"mappingId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Update sync mapping filters.","description":"Updates sync mapping filters. The ID of the sync mapping must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMappingFilter"},"examples":{"application\/json":{"mappingId":1,"type":"contains","operator":1,"source":"CategoryLevel3Name","value":"2"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"mappingId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/mapping\/{mappingId}\/row":{"post":{"summary":"Create a sync mapping row.","description":"Creates a sync mapping row.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMappingRow"},"examples":{"application\/json":{"mappingId":1,"targetModel":"Sit non est dolore.","targetAttribute":"Exercitationem.","active":0,"entityType":"source","value":"variation_number","settings":"","identifiers":""}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"mappingId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/mapping\/{mappingId}\/rows":{"get":{"summary":"List sync mapping rows.","description":"Lists sync mapping rows.","tags":["ElasticSync"],"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":"mappingId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"post":{"summary":"Create sync mapping rows.","description":"Creates sync mapping rows.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMappingRow"},"examples":{"application\/json":{"mappingId":1,"targetModel":"Nisi eveniet soluta.","targetAttribute":"Perferendis vel aut.","active":1,"entityType":"source","value":"variation_number","settings":"","identifiers":""}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"mappingId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Update sync mapping rows.","description":"Updates sync mapping rows. The ID of the sync mapping row must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMappingRow"},"examples":{"application\/json":{"mappingId":1,"targetModel":"Nulla sequi.","targetAttribute":"Rerum sed sit.","active":1,"entityType":"source","value":"variation_number","settings":"","identifiers":""}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"mappingId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/mappings":{"delete":{"summary":"Delete one or more mappings.","description":"Deletes one or multiple mappings. The mapping ID must be specified.","tags":["ElasticSync"],"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\/elastic-sync\/sync\/mappings\/copy":{"post":{"summary":"Copy one or more mappings.","description":"Copies one or multiple mappings. The mapping ID must be specified.","tags":["ElasticSync"],"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\/elastic-sync\/sync\/matching\/decimals":{"get":{"summary":"Get list of decimals.","description":"Gets list of decimals.","tags":["ElasticSync"],"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\/elastic-sync\/sync\/matching\/{matchingId}":{"delete":{"summary":"Delete a sync matching.","description":"Deletes a sync matching. The ID of the sync matching must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMatching"},"examples":{"application\/json":{"syncId":1,"target":"Temporibus nam.","source":"Porro et incidunt.","additionalValue":"Rem illo quo iste."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"matchingId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get a sync matching.","description":"Gets a sync matching. The ID of the sync matching must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMatching"},"examples":{"application\/json":{"syncId":1,"target":"Et dolores veniam.","source":"Delectus excepturi.","additionalValue":"Nemo dolorem harum."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"matchingId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Update a sync matching.","description":"Updates a sync matching. The ID of the sync matching must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMatching"},"examples":{"application\/json":{"syncId":1,"target":"Nostrum animi rerum.","source":"Magnam rerum.","additionalValue":"Voluptate nemo."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"matchingId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/option\/{optionId}":{"delete":{"summary":"Delete a sync.","description":"Deletes a sync. The ID of the sync must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncSync"},"examples":{"application\/json":{"name":"Rerum est odit odio.","syncType":"warehouse","sourceType":"http","sourceDataType":"csv","lastRun":"-0001-11-30T00:00:00+00:53"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get a sync.","description":"Gets a sync. The ID of the sync must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncSync"},"examples":{"application\/json":{"name":"Neque voluptatem ea.","syncType":"warehouse","sourceType":"http","sourceDataType":"csv","lastRun":"-0001-11-30T00:00:00+00:53"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Update a sync option.","description":"Updates a sync option. The ID of the sync must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncSync"},"examples":{"application\/json":{"name":"Voluptatum velit.","syncType":"warehouse","sourceType":"http","sourceDataType":"csv","lastRun":"-0001-11-30T00:00:00+00:53"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/report\/{id}":{"get":{"summary":"Get Log by ID","description":"Gets Log ID. The id of the report must be specified.","tags":["ElasticSync"],"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":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/reports":{"get":{"summary":"Check Report Log.","description":"Check Report Log. Filters like sync id, row id, identifier, from date, to date, id, level can be provided.","tags":["ElasticSync"],"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\/elastic-sync\/sync\/reports\/availability":{"get":{"summary":"Check Report Log.","description":"Check Report Log.","tags":["ElasticSync"],"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\/elastic-sync\/sync\/reset-cache":{"get":{"summary":"Reset the cache.","description":"Resets the cache.","tags":["ElasticSync"],"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\/elastic-sync\/sync\/schedule\/times":{"get":{"summary":"Get schedule times.","description":"Gets schedule times.","tags":["ElasticSync"],"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\/elastic-sync\/sync\/status":{"get":{"summary":"Get syncs status.","description":"Get syncs status.","tags":["ElasticSync"],"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\/elastic-sync\/sync\/types":{"get":{"summary":"Get list of sync types.","description":"Gets list of sync types.","tags":["ElasticSync"],"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\/elastic-sync\/sync\/{statusId}\/live\/processing\/{syncId}\/{page}":{"post":{"summary":"Import a page for Live Import","description":"Imports and processes every page.","tags":["ElasticSync"],"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."}},"parameters":[{"name":"statusId","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"name":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"name":"page","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/{statusId}\/live\/queueing":{"post":{"summary":"Get the list of jobs for Live Import","description":"Gets the list of jobs for Live Import","tags":["ElasticSync"],"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":"statusId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/{syncId}":{"delete":{"summary":"Delete a sync.","description":"Deletes a sync. The ID of the sync must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncSync"},"examples":{"application\/json":{"name":"Sed molestiae autem.","syncType":"warehouse","sourceType":"http","sourceDataType":"csv","lastRun":"-0001-11-30T00:00:00+00:53"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get a sync.","description":"Gets a sync. The ID of the sync must be specified.","tags":["ElasticSync"],"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":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Update a sync.","description":"Updates a sync. The ID of the sync must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncSync"},"examples":{"application\/json":{"name":"Sequi voluptate.","syncType":"warehouse","sourceType":"http","sourceDataType":"csv","lastRun":"-0001-11-30T00:00:00+00:53"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/{syncId}\/live\/initiate":{"post":{"summary":"Initiate + queue live import","description":"Initiates + queueing the jobs for Live Import","tags":["ElasticSync"],"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."}},"parameters":[{"name":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/{syncId}\/mapping":{"post":{"summary":"Create a sync mapping.","description":"Creates a sync mapping.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMapping"},"examples":{"application\/json":{"syncId":1,"name":"Quidem vero.","position":9,"active":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/{syncId}\/mappings":{"get":{"summary":"List sync mappings.","description":"Lists sync mappings.","tags":["ElasticSync"],"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":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/{syncId}\/matches":{"get":{"summary":"List sync matches.","description":"Lists sync matches.","tags":["ElasticSync"],"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":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"post":{"summary":"Create sync matches.","description":"Creates sync matches.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMatching"},"examples":{"application\/json":{"syncId":1,"target":"Quia velit nulla et.","source":"Soluta dolorum.","additionalValue":"Perspiciatis libero."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Update sync matches.","description":"Updates sync matches. The ID of the sync matching must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMatching"},"examples":{"application\/json":{"syncId":1,"target":"Vero nulla.","source":"Vitae molestiae et.","additionalValue":"Saepe dolores et."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/{syncId}\/matching":{"post":{"summary":"Create a sync matching.","description":"Creates a sync matching.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncMatching"},"examples":{"application\/json":{"syncId":1,"target":"Saepe in optio.","source":"Dignissimos aut.","additionalValue":"Autem vel dolor qui."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/{syncId}\/matching\/entity":{"get":{"summary":"Get an entity.","description":"Gets an entity by sync ID. The sync ID is required.","tags":["ElasticSync"],"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":"syncId","type":"integer","required":true,"description":"The sync ID of the mapping","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/{syncId}\/option":{"post":{"summary":"Create a sync option.","description":"Creates a sync option.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncOption"},"examples":{"application\/json":{"syncId":1,"optionIdentifier":"syncOption","key":"headerIncluded","value":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/{syncId}\/options":{"get":{"summary":"List syncs.","description":"Lists syncs.","tags":["ElasticSync"],"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":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"post":{"summary":"Create sync options.","description":"Creates sync options.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncOption"},"examples":{"application\/json":{"syncId":1,"optionIdentifier":"syncOption","key":"headerIncluded","value":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Update sync options.","description":"Updates sync options. The ID of the sync must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncSync"},"examples":{"application\/json":{"name":"Voluptates hic.","syncType":"warehouse","sourceType":"http","sourceDataType":"csv","lastRun":"-0001-11-30T00:00:00+00:53"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/{syncId}\/preview-computed":{"get":{"summary":"Get computed preview of mapped targets.","description":"Gets a computed preview of the mapped targets.","tags":["ElasticSync"],"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":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/{syncId}\/preview-values":{"get":{"summary":"Get preview of csv values.","description":"Gets preview of csv values. The sync ID is required.","tags":["ElasticSync"],"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":"syncId","type":"integer","required":true,"description":"The id of the sync","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/{syncId}\/run":{"post":{"summary":"Execute the run procedure.","description":"Executes the run procedure. Data with sync ID must be specified.","tags":["ElasticSync"],"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":"syncId","type":"integer","required":true,"description":"The ID of the sync","format":"integer","in":"path"},{"name":"testrun","type":"integer","required":true,"description":"The test run variable","format":"integer","in":"query"}]}},"\/rest\/elastic-sync\/sync\/{syncId}\/source-preview":{"get":{"summary":"Preview the syncs.","description":"Previews the syncs. The sync ID is required.","tags":["ElasticSync"],"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":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/sync\/{syncType}\/matching\/fields":{"get":{"summary":"Get a list of all mappings for a particular sync type.","description":"Gets a list of all mappings for a particular sync type.","tags":["ElasticSync"],"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":"$syncType","type":"string","required":true,"description":"The sync type of the matching","format":"string","in":"query"},{"name":"syncType","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/elastic-sync\/syncs":{"delete":{"summary":"Delete syncs.","description":"Deletes syncs. The IDs of the syncs must be specified.","tags":["ElasticSync"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ElasticSyncSync"},"examples":{"application\/json":{"name":"Consequatur.","syncType":"warehouse","sourceType":"http","sourceDataType":"csv","lastRun":"-0001-11-30T00:00:00+00:53"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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":"Get all Syncs","description":"Get all Syncs. Filters like id, name, sync type and interval can be provided.","tags":["ElasticSync"],"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\/elastic-sync\/syncs\/copy":{"post":{"summary":"Copy the syncs.","description":"Copies the syncs. The sync ID is required.","tags":["ElasticSync"],"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\/elastic-sync\/syncs\/export":{"post":{"summary":"Export the syncs.","description":"Exports the syncs. The sync ID is required.","tags":["ElasticSync"],"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":"syncIds","type":"integer","required":true,"description":"The ID of the sync","format":"integer","in":"query"}]}},"\/rest\/elastic-sync\/syncs\/export\/{syncId}":{"get":{"summary":"Export the sync.","description":"Exports the sync. The sync ID is required.","tags":["ElasticSync"],"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":"syncIds","type":"integer","required":true,"description":"The ID of the sync","format":"integer","in":"query"},{"name":"syncId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/exports":{"get":{"summary":"List elastic exports","description":"Lists elastic exports.","tags":["ExportSettings"],"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 Export","items":{"$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":"id","type":"integer","required":false,"description":"The ID of the export","format":"integer","in":"query"},{"name":"formatKey","type":"string","required":false,"description":"The format of the export","format":"string","in":"query"},{"name":"type","type":"string","required":false,"description":"The type of the export","format":"string","in":"query"},{"name":"name","type":"string","required":false,"description":"The name of the export","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 an export","description":"Creates an export. The name, formatKey, type and outputType 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":[{"in":"body","name":"\/rest\/exports","schema":{"type":"object","properties":{"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, purchase_order, purchase_order_item, 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\/format_keys":{"get":{"summary":"Get format keys","description":"Shows all format keys registered by plugins in production state","tags":["Export"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":["MyCustomExportFormat"]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/format_keys\/{type}":{"get":{"summary":"Get format keys","description":"Shows all format keys registered by plugins in production state","tags":["Export"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":["MyCustomExportFormat"]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/exports\/generate_token":{"get":{"summary":"Generate a token","description":"Creates a new token which can be used as <code>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","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, purchase_order, purchase_order_item, 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 new feedback.","tags":["Feedback"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Feedback"},"examples":{"application\/json":{"title":"Iste vel praesentium quasi quaerat molestias enim voluptas expedita esse tenetur."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"title":"Reprehenderit consequatur autem ad architecto quia minima totam."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"title":"Excepturi quasi consequatur vitae cumque quibusdam rerum suscipit eum voluptas labore optio voluptas natus."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"title":"Dolores soluta tempore esse dolorem fugiat aspernatur asperiores."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"title":"Quia praesentium voluptatem harum qui esse temporibus magni."},{"title":"Consequatur omnis harum occaecati sed sed ad accusantium molestias et error dolorem alias."}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"}},"examples":{"application\/json":[{"title":"Sed qui enim esse vitae veniam praesentium velit in minima itaque sequi ut."},{"title":"Repellat qui est sapiente sunt a aperiam."}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":{"get":{"summary":"Get all pick lists","description":"Get all pick lists for the given filters.","tags":["Fulfillment"],"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\/fulfillment\/picklist\/picking_order_item":{"get":{"summary":"Get all pick list items","description":"Gets a collection of pick list items.","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":"Get pick list item","description":"Gets a pick list item specified by its pickingOrderItemId.","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\/fulfillment\/picklist\/picking_order_item\/{pickingOrderItemId}\/status":{"post":{"summary":"Set state of a pick list item","description":"Set state of a pick list item specified by its pickingOrderItemId.","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 pick list item id","format":"integer","in":"path"},{"name":"state","type":"string","required":true,"description":"The state","format":"string","in":"query"}]}},"\/rest\/fulfillment\/picklist\/trolley_tags":{"post":{"summary":"Create trolley tag","description":"Create an trolley tag for a pick list.","tags":["Fulfillment"],"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\/fulfillment\/picklist\/trolley_tags\/{trolleyTag}":{"delete":{"summary":"Delete trolley tag","description":"Delete an trolley tag for a pick list.","tags":["Fulfillment"],"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":"trolleyTag","type":"string","required":true,"description":"The trolley tag for the pick list","format":"string","in":"path"}]},"get":{"summary":"Get a pick list","description":"Get a pick list specified by its pick list alias.","tags":["Fulfillment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PickingOrder"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"trolleyTag","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/fulfillment\/picklist\/{id}":{"get":{"summary":"Get a pick list","description":"Get a pick list specified by its pick list ID.","tags":["Fulfillment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PickingOrder"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/fulfillment\/picklist\/{id}\/{action}":{"post":{"summary":"Execute a pick list action","description":"Execute an action for the given pick list.","tags":["Fulfillment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PickingOrder"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 pick list ID","format":"integer","in":"path"},{"name":"action","type":"string","required":true,"description":"The action to execute (start, continue, reopen, close, pause) ","format":"string","in":"path"}]}},"\/rest\/fulfillment\/picklist\/{pickingOrderId}\/trolley_tags":{"delete":{"summary":"Delete trolley tag","description":"Delete a trolley tag by picking order id.","tags":["Fulfillment"],"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":"pickingOrderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/gls\/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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"environment":"sandbox","status":"active","data":{"username":"letitia36"},"market":"reiciendis"},{"environment":"sandbox","status":"active","data":{"username":"zlockman"},"market":"nihil"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"environment":"sandbox","status":"inactive","data":{"username":"jaquan89"},"market":"minus"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/gls\/credentials","schema":{"type":"object","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\/gls\/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"},"examples":{"application\/json":{"environment":"sandbox","status":"pending","data":{"username":"hartmann.joey"},"market":"sequi"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"environment":"sandbox","status":"inactive","data":{"username":"josefina60"},"market":"natus"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/gls\/credentials\/{credentialsId}","schema":{"type":"object","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\/item_sets":{"delete":{"summary":"Delete item sets","description":"Delete the 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."}}},"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 new 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":"array","required":false,"description":"includes the item sets that have to be created","format":"","in":"query","items":{"type":"string"}}]},"put":{"summary":"Update item sets","description":"Updates the 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\/item_sets\/{setId}\/config\/sales_prices":{"post":{"summary":"Trigger a sales price calculation for an item set","description":"Triggers a sales price calculation for an item set. The id of the item set 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":"setId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/items":{"get":{"summary":"Search item","description":"Searches for an 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"storeSpecial":2,"stockType":1,"ownerId":5,"manufacturerId":2,"producingCountryId":7,"revenueAccount":2,"couponRestriction":1,"condition":3,"conditionApi":3,"createdAt":"2025-07-14T21:49:04+02:00","updatedAt":"2025-04-30T18:52:30+02:00","isSubscribable":true,"isSerialNumber":false,"isShippingPackage":false,"amazonFbaPlatform":2,"isShippableByAmazon":false,"amazonFedas":"et","ebayPresetId":2,"ebayCategory":6,"ebayCategory2":3,"ebayStoreCategory":2,"ebayStoreCategory2":3,"rakutenCategoryId":2,"flagOne":28,"flagTwo":0,"ageRestriction":6,"feedback":4,"maximumOrderQuantity":73,"mainVariationId":null,"crossSellingCharacteristicId":null},{"storeSpecial":3,"stockType":1,"ownerId":6,"manufacturerId":1,"producingCountryId":5,"revenueAccount":3,"couponRestriction":1,"condition":4,"conditionApi":3,"createdAt":"2024-10-14T19:27:46+02:00","updatedAt":"2025-04-24T12:47:34+02:00","isSubscribable":true,"isSerialNumber":true,"isShippingPackage":false,"amazonFbaPlatform":2,"isShippableByAmazon":true,"amazonFedas":"in","ebayPresetId":8,"ebayCategory":3,"ebayCategory2":4,"ebayStoreCategory":1,"ebayStoreCategory2":6,"rakutenCategoryId":5,"flagOne":2,"flagTwo":8,"ageRestriction":0,"feedback":2,"maximumOrderQuantity":98,"mainVariationId":null,"crossSellingCharacteristicId":null}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 <a href='https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#countries' target='_blank'>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":"Creates new items.","tags":["Item"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Item"},"examples":{"application\/json":{"storeSpecial":2,"stockType":2,"ownerId":13,"manufacturerId":1,"producingCountryId":3,"revenueAccount":4,"couponRestriction":2,"condition":2,"conditionApi":1,"createdAt":"2025-05-12T16:12:25+02:00","updatedAt":"2025-02-20T21:56:11+01:00","isSubscribable":false,"isSerialNumber":true,"isShippingPackage":false,"amazonFbaPlatform":1,"isShippableByAmazon":false,"amazonFedas":"dolorem","ebayPresetId":5,"ebayCategory":3,"ebayCategory2":1,"ebayStoreCategory":8,"ebayStoreCategory2":8,"rakutenCategoryId":9,"flagOne":0,"flagTwo":4,"ageRestriction":12,"feedback":2,"maximumOrderQuantity":8,"mainVariationId":null,"crossSellingCharacteristicId":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","properties":{"position":{"type":"integer","description":"The position of the item optional"},"stockType":{"type":"integer","description":"The stock type of the item. Possible values:\n0 = Stocked item (default)\n 1 = Production item\n 2 = Colli\n 3 = 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.\n1 = 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;\nusually a 11 digit code number based on the Harmonised System optional"},"revenueAccount":{"type":"integer","description":"The revenue account the item is linked to.\nAn individual revenue account can be saved for each item in plentymarkets.\nIf this is not done, plentymarkets automatically determines a revenue account\nbased on the VAT rate. optional"},"couponRestriction":{"type":"integer","description":"Indicates if the item can be purchased using a promotional coupon.\n0 = Permitted\n 1 = Not permitted\n 2 = Purchasable with coupon only optional allowed values are 0, 1, 2"},"condition":{"type":"integer","description":"The condition of the item. Possible values:\n0 = New1 = Used\n 2 = Boxed as new\n 3 = New with label\n 4 = 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.\n0 = New\n 1 = Used but as new\n 2 = Used but very good\n 3 = Used but good\n 4 = Used but acceptable\n 5 = 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.\nIf 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.\nIf yes and the variation's dimensions are entered in the Settings tab of a\nvariation, the correct shipping package is assigned automatically. optional"},"amazonFbaPlatform":{"type":"integer","description":"Indicates the platform used for Fulfilment by Amazon (FBA).\n0 = Do not use\n 1 = AMAZON EU (Europe)\n 2 = AMAZON FE (Far East)\n 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.\nAmazon Multi-Channel Fulfillment is a service for fulfilling orders from sales\nchannels other than Amazon platforms using inventory stored in the Amazon\nfulfillment center. optional"},"amazonProductType":{"type":"integer","description":"The Amazon product type of the item (deprecated as of June 2025). List of IDs:\nhttps:\/\/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\n$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.\nThis value is used for new listings. optional"},"ebayStoreCategory2":{"type":"integer","description":"The ID of the eBay store category 2 of the item.\nThis 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.\nEach 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.\nEach 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.\nItems with an age rating of 18+ must be linked to a shipping profile for which the\nPostIdent option is activated.\n0 = None available\n 3 = Released for ages 3 and up\n 6 = Ages 6 and up\n 9 = Ages 9 and up\n 12 = Ages 12 and up\n 14 = Ages 14 and up\n 16 = Ages 16 and up\n 18 = Ages 18 and up\n 50 = Not marked\n 88 = Not \n 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.\nPossible values are 1 to 5 or 1 to 10 depending on the maximum rating setting.\nAn initial feedback can be saved for items. The saved value will then be displayed as the\ninitial feedback. Every time new feedback is submitted, the average value will be\nrecalculated automatically. optional"},"itemType":{"type":"string","description":"The type of the item. Because Set items are managed using a separate route,\nthis value is always Default. optional allowed values are default, multiPack, set"},"ebayTitles":{"type":"array","items":{"$ref":"#\/definitions\/ItemEbayTitle"}},"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"},"examples":{"application\/json":{"success":{"1":{"id":102,"position":0,"manufacturerId":2,"stockType":0,"add_cms_page":"0","storeSpecial":0,"condition":0,"amazonFedas":"","updatedAt":"2018-09-05T13:07:00+02:00","free1":null,"free2":null,"free3":null,"free4":null,"free5":null,"free6":null,"free7":"0","free8":"0","free9":"0","free10":"0","free11":"0","free12":"0","free13":"0","free14":"0","free15":"0","free16":"0","free17":"0","free18":"0","free19":"0","free20":"0","producingCountryId":1,"revenueAccount":0,"couponRestriction":0,"flagOne":1,"flagTwo":3,"ageRestriction":0,"createdAt":"2014-12-24T00:00:00+01:00","amazonProductType":0,"ebayPresetId":null,"ebayCategory":null,"ebayCategory2":null,"ebayStoreCategory":null,"ebayStoreCategory2":null,"amazonFbaPlatform":0,"feedback":0,"maximumOrderQuantity":0,"isSubscribable":false,"rakutenCategoryId":0,"isShippingPackage":false,"conditionApi":0,"isSerialNumber":false,"isShippableByAmazon":false,"ownerId":null,"itemType":"default","mainVariationId":1000,"ebayTitles":[],"texts":[{"lang":"de","name1":"Moderner Ledersessel \u00bbSeattle\u00ab gr\u00fcn","name2":"","name3":"","shortDescription":"Design mit Schwung. Qualit\u00e4t h\u00f6chster G\u00fcte. 1 A Sitzkomfort.","metaDescription":"Moderner Ledersessel \u00bbSeattle\u00ab gr\u00fcn Wohnzimmer Sessel & Sofas","description":"","technicalData":"Moderner Ledersessel","urlPath":"wohnzimmer\/sessel-sofas\/moderner-ledersessel-seattle-gr-n","keywords":""}]}},"failed":{"2":["Der gew\u00e4hlte Wert f\u00fcr flag one ist ung\u00fcltig."],"3":["No query results for model [Plenty\\Modules\\Item\\Item\\Models\\Item] 5000"]}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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:\n0 = Stocked item (default)\n 1 = Production item\n 2 = Colli\n 3 = 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.\n1 = 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;\nusually a 11 digit code number based on the Harmonised System optional"},"revenueAccount":{"type":"integer","description":"The revenue account the item is linked to.\nAn individual revenue account can be saved for each item in plentymarkets.\nIf this is not done, plentymarkets automatically determines a revenue account\nbased on the VAT rate. optional"},"couponRestriction":{"type":"integer","description":"Indicates if the item can be purchased using a promotional coupon.\n0 = Permitted\n 1 = Not permitted\n 2 = Purchasable with coupon only optional allowed values are 0, 1, 2"},"condition":{"type":"integer","description":"The condition of the item. Possible values:\n0 = New1 = Used\n 2 = Boxed as new\n 3 = New with label\n 4 = 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.\n0 = New\n 1 = Used but as new\n 2 = Used but very good\n 3 = Used but good\n 4 = Used but acceptable\n 5 = 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.\nIf 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.\nIf yes and the variation's dimensions are entered in the Settings tab of a\nvariation, the correct shipping package is assigned automatically. optional"},"amazonFbaPlatform":{"type":"integer","description":"Indicates the platform used for Fulfilment by Amazon (FBA).\n0 = Do not use\n 1 = AMAZON EU (Europe)\n 2 = AMAZON FE (Far East)\n 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.\nAmazon Multi-Channel Fulfillment is a service for fulfilling orders from sales\nchannels other than Amazon platforms using inventory stored in the Amazon\nfulfillment center. optional"},"amazonProductType":{"type":"integer","description":"The Amazon product type of the item (deprecated as of June 2025). List of IDs:\nhttps:\/\/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\n$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.\nThis value is used for new listings. optional"},"ebayStoreCategory2":{"type":"integer","description":"The ID of the eBay store category 2 of the item.\nThis 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.\nEach 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.\nEach 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.\nItems with an age rating of 18+ must be linked to a shipping profile for which the\nPostIdent option is activated.\n0 = None available\n 3 = Released for ages 3 and up\n 6 = Ages 6 and up\n 9 = Ages 9 and up\n 12 = Ages 12 and up\n 14 = Ages 14 and up\n 16 = Ages 16 and up\n 18 = Ages 18 and up\n 50 = Not marked\n 88 = Not \n 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.\nPossible values are 1 to 5 or 1 to 10 depending on the maximum rating setting.\nAn initial feedback can be saved for items. The saved value will then be displayed as the\ninitial feedback. Every time new feedback is submitted, the average value will be\nrecalculated automatically. optional"},"itemType":{"type":"string","description":"The type of the item. Because Set items are managed using a separate route,\nthis value is always Default. optional allowed values are default, multiPack, set"},"ebayTitles":{"type":"array","items":{"$ref":"#\/definitions\/ItemEbayTitle"}},"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"}},"examples":{"application\/json":[{"valueId":148,"lang":"hy","name":"Lesly Station"},{"valueId":149,"lang":"sk","name":"Torphy Inlet"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"valueId":147,"lang":"ka","name":"Ullrich Shores"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"valueId":150,"lang":"cu","name":"Franecki Gardens"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"The ID of the attribute value.","format":"integer","in":"path"},{"name":"lang","type":"string","required":true,"description":"The language of the attribute value.","format":"string","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"},"examples":{"application\/json":{"valueId":151,"lang":"qu","name":"Tina Summit"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"backendName":"ee7a233f-b2bd-3831-bfc6-c76677b0b05e","position":8,"isSurchargePercental":true,"isLinkableToImage":false,"amazonAttribute":"Quo consectetur officiis quod cupiditate facere et autem. Et temporibus aut fugit eum.","fruugoAttribute":"size","pixmaniaAttribute":8,"ottoAttribute":"Dimension1","googleShoppingAttribute":"size","neckermannAtEpAttribute":4,"typeOfSelectionInOnlineStore":"image","laRedouteAttribute":9,"isGroupable":false},{"backendName":"7c802e40-d40c-327f-bc71-2e3c42fbcf48","position":1,"isSurchargePercental":true,"isLinkableToImage":true,"amazonAttribute":"Sint possimus eveniet eligendi. Placeat ea ratione laborum.","fruugoAttribute":"null","pixmaniaAttribute":9,"ottoAttribute":"Dimension2","googleShoppingAttribute":"material","neckermannAtEpAttribute":2,"typeOfSelectionInOnlineStore":"box","laRedouteAttribute":8,"isGroupable":true}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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: <ul><li>names<\/b> = The names of the attribute<\/li><li>values<\/b> = The values of the attribute<\/li><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"},"examples":{"application\/json":{"backendName":"23c03f60-dda6-3082-bb0b-bdcc8d9472fb","position":5,"isSurchargePercental":true,"isLinkableToImage":true,"amazonAttribute":"Repellat vero possimus incidunt non sint aut.","fruugoAttribute":"null","pixmaniaAttribute":8,"ottoAttribute":"Dimension3","googleShoppingAttribute":"none","neckermannAtEpAttribute":3,"typeOfSelectionInOnlineStore":"image","laRedouteAttribute":7,"isGroupable":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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","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"}},"examples":{"application\/json":[{"attributeId":165,"lang":"kj","name":"Gorczany Mountains"},{"attributeId":166,"lang":"bm","name":"Pollich Bypass"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"attributeId":164,"lang":"tt","name":"Brennan Plains"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"attributeId":167,"lang":"tt","name":"Emmanuel Freeway"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"The ID of the attribute.","format":"integer","in":"path"},{"name":"lang","type":"string","required":true,"description":"The language of the attribute.","format":"string","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"},"examples":{"application\/json":{"attributeId":168,"lang":"as","name":"Dickinson Alley"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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":"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","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","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"attributeId":170,"backendName":"Courtney Island","position":3,"image":"attr_6.png","comment":"Eum magni et et id ab tempora reiciendis cupiditate cum vero repellendus cumque ut accusantium voluptas ratione nihil dolorem qui quia qui possimus nostrum explicabo libero.","amazonValue":"excepturi","ottoValue":"at","neckermannAtEpValue":"ullam","laRedouteValue":"dolor","tracdelightValue":"voluptas","percentageDistribution":57},{"attributeId":171,"backendName":"Altenwerth Field","position":1,"image":"attr_3.png","comment":"Laborum quo quod doloribus asperiores qui enim ducimus eum aperiam molestiae ex voluptatem hic necessitatibus hic animi necessitatibus harum id deserunt quas dolores.","amazonValue":"quam","ottoValue":"suscipit","neckermannAtEpValue":"et","laRedouteValue":"quaerat","tracdelightValue":"necessitatibus","percentageDistribution":53}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>attribute = The attribute of the value<\/li><li>names = The attribute value names in all languages<\/li><li>marketNames = The market attribute value links (amazon only)<\/li><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"},"examples":{"application\/json":{"attributeId":169,"backendName":"Hahn Point","position":8,"image":"attr_4.png","comment":"Enim qui velit maxime illo et in odit amet omnis qui accusantium commodi unde dolorem magni laboriosam sed quia deleniti magni dignissimos.","amazonValue":"velit","ottoValue":"saepe","neckermannAtEpValue":"saepe","laRedouteValue":"quia","tracdelightValue":"enim","percentageDistribution":51}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"attributeId":172,"backendName":"Ziemann Haven","position":8,"image":"attr_5.png","comment":"Voluptates illum ipsa fugiat nam laborum alias accusamus delectus sequi corrupti dolorem et labore corporis accusamus consequatur recusandae.","amazonValue":"animi","ottoValue":"est","neckermannAtEpValue":"non","laRedouteValue":"aut","tracdelightValue":"dolorem","percentageDistribution":32}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>attribute = The attribute of the value<\/li><li>names = The attribute value names in all languages<\/li><li>marketNames = The market attribute value links (amazon only)<\/li><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"},"examples":{"application\/json":{"attributeId":173,"backendName":"Donato Freeway","position":7,"image":"attr_5.png","comment":"Iure et fuga laborum ut quae voluptas explicabo eos recusandae quis corrupti ut blanditiis illum et architecto officia rerum sed et.","amazonValue":"omnis","ottoValue":"explicabo","neckermannAtEpValue":"quibusdam","laRedouteValue":"ea","tracdelightValue":"possimus","percentageDistribution":17}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"backendName":"df8a6089-fd7d-3597-9eaa-3c8d72ec28c1","position":1,"isSurchargePercental":false,"isLinkableToImage":false,"amazonAttribute":"In voluptatibus sapiente molestiae deserunt veritatis repellendus. Illo non cum at ut.","fruugoAttribute":"null","pixmaniaAttribute":8,"ottoAttribute":"Dimension3","googleShoppingAttribute":"size","neckermannAtEpAttribute":6,"typeOfSelectionInOnlineStore":"image","laRedouteAttribute":2,"isGroupable":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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: <ul><li>names<\/b> = The names of the attribute<\/li><li>values<\/b> = The values of the attribute<\/li><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"},"examples":{"application\/json":{"backendName":"485351a3-798a-3841-8080-7a00e29711c9","position":2,"isSurchargePercental":true,"isLinkableToImage":true,"amazonAttribute":"Illum aspernatur fugit distinctio facere. Aperiam qui in vero id temporibus.","fruugoAttribute":"size","pixmaniaAttribute":7,"ottoAttribute":"Dimension4","googleShoppingAttribute":"color","neckermannAtEpAttribute":3,"typeOfSelectionInOnlineStore":"dropdown","laRedouteAttribute":1,"isGroupable":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 available 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"name":"mdickens","type":"GTIN_13"},{"name":"jones.waldo","type":"GTIN_13"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 new barcode.","tags":["Item"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Barcode"},"examples":{"application\/json":{"name":"celestine.tromp","type":"GTIN_14"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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"},"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"}},"examples":{"application\/json":[{"name":"lottie.schroeder","type":"GTIN_14"},{"name":"mdaniel","type":"GTIN_128"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"name":"vandervort.shirley","type":"GTIN_8"},{"name":"rudy55","type":"GTIN_14"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"name":"luisa11","type":"GTIN_8"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"name":"skylar.stamm","type":"UPC"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"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<ul>\n<li>eq = Equal to<\/li>\n<li>gte = Greater than or equal to<\/li>\n<li>gt = Greater than<\/li>\n<li>lte = Less than or equal to<\/li>\n<li>lt = Less than<\/li>\n<li>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\/listings\/categories":{"get":{"summary":"Search for item listing categories","description":"Searches for item listing categories. The following 3 filter are mandatory: market and marketSideId. parentId is optional.","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\/listings\/categories\/{id}":{"get":{"summary":"Get one item listing categories","description":"Gets one item listing categories. The ID must be specified.","tags":["Item"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ItemListingCategory"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/listings\/shop_categories\/{ebayAccountId}":{"get":{"summary":"Get a list of item listing shop categories","description":"Gets a list of item listing shop categories for the specified user ID","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":"ebayAccountId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"name":"Lockman Inc PLC","logo":"https:\/\/cdn.your-domain.com\/images\/fakeLogo.png","url":"http:\/\/www.hilpert.org\/ad-quia-repellat-aut-corrupti-dolorem-dicta-corporis","pixmaniaBrandId":0,"neckermannBrandId":1,"externalName":"Lynch Group","neckermannAtEpBrandId":2,"street":null,"houseNo":"Neck","postcode":"00252-9302","town":null,"countryId":null,"phoneNumber":"283.500.3321","faxNumber":null,"email":"","laRedouteBrandId":2,"comment":"Et magni ut illum et nostrum aspernatur nihil. Et officia facere quod ut eum. Laborum quis reprehenderit saepe illo qui sapiente. In est vitae aspernatur."},{"name":"Lowe-Beier LLC","logo":"https:\/\/cdn.your-domain.com\/images\/fakeLogo.png","url":"http:\/\/hessel.info\/non-ea-alias-eveniet-qui","pixmaniaBrandId":2,"neckermannBrandId":0,"externalName":"Gaylord Inc","neckermannAtEpBrandId":0,"street":"Ruby Plaza","houseNo":null,"postcode":null,"town":"West Juliet","countryId":null,"phoneNumber":null,"faxNumber":null,"email":"dalton.raynor@bauch.org","laRedouteBrandId":2,"comment":null}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"name":"Strosin-Jacobson Inc","logo":"https:\/\/cdn.your-domain.com\/images\/fakeLogo.png","url":"http:\/\/www.flatley.info\/perspiciatis-quam-iure-error-incidunt-dolor-ipsam-est.html","pixmaniaBrandId":2,"neckermannBrandId":2,"externalName":"Ledner, Jast and Effertz","neckermannAtEpBrandId":2,"street":"Hardy Ranch","houseNo":null,"postcode":null,"town":"Monserrateland","countryId":2,"phoneNumber":null,"faxNumber":null,"email":"","laRedouteBrandId":0,"comment":"Rerum asperiores doloribus sit dolores. Rem omnis aut corrupti ut sint inventore et."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"name":"Batz-Sipes Group","logo":"https:\/\/cdn.your-domain.com\/images\/fakeLogo.png","url":"http:\/\/www.barrows.com\/nam-consequatur-sint-dolorem-ut-et-sit-voluptatem-fuga","pixmaniaBrandId":2,"neckermannBrandId":1,"externalName":"O'Reilly, Bogan and Harvey","neckermannAtEpBrandId":2,"street":null,"houseNo":"Greens","postcode":null,"town":null,"countryId":null,"phoneNumber":null,"faxNumber":"615.918.1303","email":"","laRedouteBrandId":1,"comment":"Itaque eveniet ipsam commodi. Quia cumque exercitationem sed magnam a. Nihil non voluptatum rerum."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"name":"Mayer-Smitham LLC","logo":"https:\/\/cdn.your-domain.com\/images\/fakeLogo.png","url":"http:\/\/www.hoeger.com\/et-enim-aliquam-aut-ut","pixmaniaBrandId":1,"neckermannBrandId":0,"externalName":"Schaefer-Mertz","neckermannAtEpBrandId":0,"street":"Emard Walks","houseNo":null,"postcode":"65645","town":"East Keven","countryId":2,"phoneNumber":null,"faxNumber":"231.468.2458","email":"","laRedouteBrandId":0,"comment":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"position":2,"propertyGroupId":24,"unit":2,"backendName":"LightYellow","comment":"Illo vero quia enim eos nemo earum.","valueType":2,"isSearchable":false,"isOderProperty":false,"isShownOnItemPage":false,"isShownOnItemList":true,"isShownAtCheckout":true,"isShownInPdf":true,"isShownAsAdditionalCosts":true,"surcharge":306078.349},{"position":3,"propertyGroupId":25,"unit":2,"backendName":"DarkTurquoise","comment":"Id delectus animi sit voluptas id impedit.","valueType":1,"isSearchable":true,"isOderProperty":true,"isShownOnItemPage":false,"isShownOnItemList":false,"isShownAtCheckout":true,"isShownInPdf":false,"isShownAsAdditionalCosts":true,"surcharge":103.631823}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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: <ul><li>names<\/b> = The names of the property<\/li><li>group<\/b> = The property group assigned to the property<\/li><li>marketComponents<\/b> = Lists the markets where the property is available <\/li><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":"ids","type":"string","required":false,"description":"Filter restricts the list of results to items with the specified id criteria. Allowed comparators are 'eq' and 'in'.","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 new property.","tags":["Item"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Property"},"examples":{"application\/json":{"position":3,"propertyGroupId":23,"unit":5,"backendName":"LightSalmon","comment":"Doloremque exercitationem quos itaque necessitatibus eveniet odit iure.","valueType":8,"isSearchable":true,"isOderProperty":false,"isShownOnItemPage":true,"isShownOnItemList":true,"isShownAtCheckout":false,"isShownInPdf":true,"isShownAsAdditionalCosts":true,"surcharge":267662289.09}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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 allowed values are C62, KGM, GRM, MGM, LTR, DPC, OP, BL, DI, BG, ST, D64, PD, QR, BX, CL, CH, TN, CA, DZN, BJ, CS, Z3, BO, OZA, JR, CG, CT, KT, AA, MTR, MLT, MMT, PR, PA, PK, D97, MTK, CMK, MMK, SCM, SMM, RO, SA, SET, RL, EA, TU, OZ, WE, CMT, INH"},"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"},"examples":{"application\/json":{"position":1,"propertyGroupId":26,"unit":6,"backendName":"Gainsboro","comment":"Nihil incidunt labore rem eligendi eum.","valueType":9,"isSearchable":true,"isOderProperty":true,"isShownOnItemPage":false,"isShownOnItemList":true,"isShownAtCheckout":true,"isShownInPdf":true,"isShownAsAdditionalCosts":true,"surcharge":27619}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"position":5,"propertyGroupId":27,"unit":6,"backendName":"Maroon","comment":"Ullam sit cumque tempore rerum aut molestiae temporibus.","valueType":9,"isSearchable":false,"isOderProperty":true,"isShownOnItemPage":true,"isShownOnItemList":false,"isShownAtCheckout":false,"isShownInPdf":false,"isShownAsAdditionalCosts":false,"surcharge":253.751674929}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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 allowed values are C62, KGM, GRM, MGM, LTR, DPC, OP, BL, DI, BG, ST, D64, PD, QR, BX, CL, CH, TN, CA, DZN, BJ, CS, Z3, BO, OZA, JR, CG, CT, KT, AA, MTR, MLT, MMT, PR, PA, PK, D97, MTK, CMK, MMK, SCM, SMM, RO, SA, SET, RL, EA, TU, OZ, WE, CMT, INH"},"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","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","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","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","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"}},"examples":{"application\/json":[{"propertyId":20,"lang":"fj","name":"Dr. Veronica Smith V","description":"Dolorum velit doloremque dicta perspiciatis non alias."},{"propertyId":21,"lang":"bs","name":"Asa Walker II","description":"Magni consequatur et autem sit reiciendis dolorem eos a."}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"propertyId":18,"lang":"lo","name":"Alexane Terry","description":"Vel et non amet alias repudiandae molestiae delectus aliquid."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"propertyId":24,"lang":"cy","name":"Dr. Jayce Schneider","description":"Ut non expedita dicta dolores iusto unde est."},{"propertyId":25,"lang":"rw","name":"Robert Kihn","description":"Voluptatem quibusdam consequuntur saepe dolor."}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"propertyId":19,"lang":"mi","name":"Sarina Littel","description":"Odio aut recusandae non sit."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"propertyId":26,"lang":"nl","name":"Mr. Stone Bogan","description":"Autem debitis dolores animi ut."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"propertyId":27,"lang":"af","name":"Randy Reinger","description":"Omnis commodi quibusdam nemo omnis nostrum ipsam."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"propertyId":22,"lang":"st","name":"Miss Jude Daniel V","description":"Corrupti similique in dolorem laborum omnis at."},{"propertyId":23,"lang":"hi","name":"Jacynthe Nicolas","description":"Aut et ut nihil sint dolorem aut iure."}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"backendName":"Steve Kshlerin","orderPropertyGroupingType":"none","isSurchargePercental":true},{"backendName":"Prof. Brandon Donnelly I","orderPropertyGroupingType":"single","isSurchargePercental":true}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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: <ul><li>names<\/b> = The names of the property group<\/li><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"},"examples":{"application\/json":{"backendName":"Mr. Ladarius Haley","orderPropertyGroupingType":"multi","isSurchargePercental":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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"},"examples":{"application\/json":{"backendName":"Mr. Terrance Kuhic","orderPropertyGroupingType":"single","isSurchargePercental":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"backendName":"Prof. Ibrahim Kreiger PhD","orderPropertyGroupingType":"none","isSurchargePercental":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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","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","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"position":9,"minimumOrderQuantity":87.4,"type":"rrp","isCustomerPrice":false,"isDisplayedByDefault":false,"isLiveConversion":true,"interval":"daily"},{"position":39,"minimumOrderQuantity":94.56,"type":"default","isCustomerPrice":true,"isDisplayedByDefault":false,"isLiveConversion":true,"interval":"daily"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"position":50,"minimumOrderQuantity":3.61,"type":"specialOffer","isCustomerPrice":false,"isDisplayedByDefault":true,"isLiveConversion":false,"interval":"monthly"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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, set, 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"},"examples":{"application\/json":{"position":65,"minimumOrderQuantity":38.61,"type":"default","isCustomerPrice":true,"isDisplayedByDefault":true,"isLiveConversion":false,"interval":"none"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"position":53,"minimumOrderQuantity":36.9,"type":"specialOffer","isCustomerPrice":false,"isDisplayedByDefault":false,"isLiveConversion":false,"interval":"monthly"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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, set, 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"}},"examples":{"application\/json":[{"accountId":9,"referrerId":4},{"accountId":3,"referrerId":1}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"accountId":2,"referrerId":3}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"countryId":5},{"countryId":4}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"countryId":7}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"currency":"SHP"},{"currency":"TRY"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"currency":"PLN"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"customerClassId":986},{"customerClassId":70}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"customerClassId":828}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"lang":"an","nameInternal":"MUR","nameExternal":"MUR"},{"lang":"sv","nameInternal":"AWG","nameExternal":"AWG"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"lang":"lv","nameInternal":"SCR","nameExternal":"SCR"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"salesPriceId","type":"integer","required":true,"description":"The ID of the sales price.","format":"integer","in":"query"},{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"in":"body","name":"\/rest\/items\/sales_prices\/{id}\/names","schema":{"type":"object","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":"salesPriceId","type":"integer","required":true,"description":"The ID of the sales price.","format":"integer","in":"query"},{"name":"lang","type":"string","required":true,"description":"The language of the sales price.","format":"string","in":"path"},{"name":"id","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"},"examples":{"application\/json":{"lang":"ja","nameInternal":"AOA","nameExternal":"AOA"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"salesPriceId","type":"integer","required":true,"description":"The ID of the sales price.","format":"integer","in":"query"},{"name":"lang","type":"string","required":true,"description":"The language of the sales price.","format":"string","in":"path"},{"name":"id","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"},"examples":{"application\/json":{"lang":"an","nameInternal":"GEL","nameExternal":"GEL"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"salesPriceId","type":"integer","required":true,"description":"The ID of the sales price.","format":"integer","in":"query"},{"name":"lang","type":"string","required":true,"description":"The language of the sales price.","format":"string","in":"path"},{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"in":"body","name":"\/rest\/items\/sales_prices\/{id}\/names\/{lang}","schema":{"type":"object","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"}},"examples":{"application\/json":[{"plentyId":1},{"plentyId":2}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"plentyId":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"referrerId":1740.52},{"referrerId":2184.15}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"referrerId":1062.46}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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 available 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"position":279,"unitOfMeasurement":"C62","isDecimalPlacesAllowed":false},{"position":578,"unitOfMeasurement":"C62","isDecimalPlacesAllowed":false}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 new unit.","tags":["Item"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Unit"},"examples":{"application\/json":{"position":195,"unitOfMeasurement":"GRM","isDecimalPlacesAllowed":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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\/unitsOfMeasurements":{"get":{"summary":"Get list with units of measurements","description":"Gets a list of unit measurement ISOs.","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":"language","type":"string","required":false,"description":"Language is required to be used for extracting the translations from item\/unit.","format":"string","in":"query"}]}},"\/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"},"examples":{"application\/json":{"position":729,"unitOfMeasurement":"KGM","isDecimalPlacesAllowed":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"position":447,"unitOfMeasurement":"KGM","isDecimalPlacesAllowed":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"unitId":null,"lang":"ga","name":"Immanuel Thompson"},{"unitId":null,"lang":"fr","name":"Dr. Louvenia Senger"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"unitId":null,"lang":"ru","name":"Kamren Abbott"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"unitId":null,"lang":"es","name":"Elliott Johnson"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"unitId":null,"lang":"ga","name":"Leann Hartmann"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"isMain":false,"mainVariationId":null,"itemId":10060,"position":92,"isActive":true,"number":"E-737739","unitCombinationId":80,"model":"in","externalId":null,"availability":1,"estimatedAvailableAt":"2025-09-21T00:00:00+02:00","purchasePrice":72.34,"createdAt":"2024-11-18T21:17:22+01:00","updatedAt":"2025-09-02T18:35:14+02:00","relatedUpdatedAt":"2025-09-02T18:30:18+02:00","priceCalculationId":null,"picking":"exclude_from_picklist","stockLimitation":0,"isVisibleIfNetStockIsPositive":true,"isInvisibleIfNetStockIsNotPositive":false,"isAvailableIfNetStockIsPositive":false,"isUnavailableIfNetStockIsNotPositive":false,"mainWarehouseId":195,"maximumOrderQuantity":74.37,"minimumOrderQuantity":41.35,"intervalOrderQuantity":93.99,"availableUntil":"2025-09-23T00:00:00+02:00","releasedAt":"2025-08-30T00:00:00+02:00","name":"ckutch","weightG":4,"weightNetG":8,"widthMM":2,"lengthMM":7,"heightMM":9,"extraShippingCharge1":66.76,"extraShippingCharge2":52.66,"unitsContained":8,"palletTypeId":4,"packingUnits":1,"packingUnitTypeId":1,"transportationCosts":51.91,"storageCosts":80.51,"customs":57.18,"operatingCosts":84.58,"vatId":2,"bundleType":null,"automaticClientVisibility":0,"isHiddenInCategoryList":false,"categoryVariationId":0,"marketVariationId":0,"clientVariationId":0,"salesPriceVariationId":0,"supplierVariationId":0,"warehouseVariationId":0,"propertyVariationId":0,"tagVariationId":0,"salesRank":null},{"isMain":false,"mainVariationId":null,"itemId":10061,"position":85,"isActive":false,"number":"F-679462","unitCombinationId":81,"model":"ut","externalId":null,"availability":1,"estimatedAvailableAt":"2025-09-19T00:00:00+02:00","purchasePrice":35.83,"createdAt":"2025-08-10T21:10:01+02:00","updatedAt":"2025-09-01T12:54:22+02:00","relatedUpdatedAt":"2025-08-31T18:55:59+02:00","priceCalculationId":null,"picking":null,"stockLimitation":0,"isVisibleIfNetStockIsPositive":true,"isInvisibleIfNetStockIsNotPositive":true,"isAvailableIfNetStockIsPositive":true,"isUnavailableIfNetStockIsNotPositive":true,"mainWarehouseId":196,"maximumOrderQuantity":73.99,"minimumOrderQuantity":31.02,"intervalOrderQuantity":39.08,"availableUntil":"2025-09-18T00:00:00+02:00","releasedAt":"2025-09-02T00:00:00+02:00","name":"schuyler29","weightG":9,"weightNetG":2,"widthMM":3,"lengthMM":2,"heightMM":2,"extraShippingCharge1":13.52,"extraShippingCharge2":96.81,"unitsContained":7,"palletTypeId":3,"packingUnits":1,"packingUnitTypeId":5,"transportationCosts":85.48,"storageCosts":35.51,"customs":25.38,"operatingCosts":76.48,"vatId":1,"bundleType":null,"automaticClientVisibility":1,"isHiddenInCategoryList":true,"categoryVariationId":0,"marketVariationId":0,"clientVariationId":0,"salesPriceVariationId":0,"supplierVariationId":0,"warehouseVariationId":0,"propertyVariationId":0,"tagVariationId":0,"salesRank":null}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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: <ul><li>properties<\/b> = The properties linked to the variation<\/li><li>variationProperties<\/b> = The properties linked to the variation<\/li><li>variationBarcodes<\/b> = The barcode linked to the variation and the saved code<\/li><li>variationBundleComponents<\/b> = The bundle components of the variation and their quantities<\/li><li>variationComponentBundles<\/b> = The bundles that this variation is a component of<\/li><li>variationSalesPrices<\/b> = The sales prices linked to the variation and the saved price<\/li><li>marketItemNumbers<\/b> = The market ident number of the variation<\/li><li>variationCategories<\/b> = The categories linked to the variation<\/li><li>variationClients<\/b> = The clients (stores) for which the variation is activated<\/li><li>variationMarkets<\/b> = The markets for which the variation is activated <\/li><li>variationDefaultCategory<\/b> = The default category of the variation<\/li><li>variationSuppliers<\/b> = The supplier data associated with the variation<\/li><li>variationWarehouses<\/b> = The warehouse data associated with the variation<\/li><li>images<\/b> = The images linked to the variation<\/li><li>itemImages<\/b> = The images linked to the item<\/li><li>variationAttributeValues<\/b> = The attribute values of the variation<\/li><li>variationSkus<\/b> = The SKU data associated with the variation<\/li><li>variationAdditionalSkus<\/b> = The additional SKU data associated with the variation<\/li><li>unit<\/b> = The unit assigned to the variation<\/li><li>parent<\/b> = The main variation of the variation. Value is null if this variation is the item's main variation.<\/li><li>item<\/b> = The item of the variation<\/li><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 <a href='https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#countries' target='_blank'>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. Default value is 1.","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. Default value is 50.","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":"supplierNumberFuzzy","type":"string","required":false,"description":"Filter restricts the list of results to variations that contain the specified supplier number (SQL LIKE operator).","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","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":"string","description":"The ID of the price calculation linked to the variation. (deprecated) 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"},"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","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","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"variationId":1005,"marketId":4.09},{"variationId":1001,"marketId":102.06}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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","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"},"examples":{"application\/json":{"failed":{"1":["property ID must be specified."],"2":["Variation ID must be specified."]},"success":{"3":{"id":24,"itemId":102,"propertyId":1,"propertySelectionId":null,"valueInt":null,"valueFloat":null,"valueFile":null,"surcharge":0,"variationId":1000,"property":{"id":1,"position":0,"unit":null,"propertyGroupId":null,"backendName":"Blau","valueType":"empty","isSearchable":false,"isOderProperty":false,"isShownOnItemPage":false,"isShownOnItemList":false,"isShownAtCheckout":false,"isShownInPdf":false,"comment":"","surcharge":0,"isShownAsAdditionalCosts":false,"updatedAt":"2017-11-09T08:48:44+01:00"},"valueTexts":[],"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":[{"in":"body","name":"\/rest\/items\/variations\/variation_properties","schema":{"type":"object","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"},"examples":{"application\/json":{"failed":{"1":["property ID must be specified."],"2":["Variation ID must be specified."]},"success":{"3":{"id":24,"itemId":102,"propertyId":1,"propertySelectionId":null,"valueInt":null,"valueFloat":null,"valueFile":null,"surcharge":0,"variationId":1000,"property":{"id":1,"position":0,"unit":null,"propertyGroupId":null,"backendName":"Blau","valueType":"empty","isSearchable":false,"isOderProperty":false,"isShownOnItemPage":false,"isShownOnItemList":false,"isShownAtCheckout":false,"isShownInPdf":false,"comment":"","surcharge":0,"isShownAsAdditionalCosts":false,"updatedAt":"2017-11-09T08:48:44+01:00"},"valueTexts":[],"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":[{"in":"body","name":"\/rest\/items\/variations\/variation_properties","schema":{"type":"object","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"},"examples":{"application\/json":{"failed":{"1":["Sales price ID must be specified."],"3":["Variation ID must be specified.","Price must be specified."]},"success":{"3":{"variationId":1147,"salesPriceId":3,"price":0,"updatedAt":"2017-12-05T11:10:05+01:00","createdAt":null}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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"},"lowestPrice":{"type":"number","description":"The lowest price of the variation saved for this sales price optional"},"lowestPriceCalculation":{"type":"boolean","description":"Is the lowest price calculation active for this sales price optional"}}}}]},"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"},"examples":{"application\/json":{"failed":{"1":["No variation price found."],"2":["Sales price ID must be specified."],"4":["Variation ID must be specified.","Price must be specified."]},"success":{"3":{"variationId":1147,"salesPriceId":3,"price":0,"updatedAt":"2017-12-05T11:10:05+01:00","createdAt":null}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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"},"lowestPrice":{"type":"number","description":"The lowest price of the variation saved for this sales price optional"},"lowestPriceCalculation":{"type":"boolean","description":"Is the lowest price calculation active for this sales price optional"}}}}]}},"\/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"}},"examples":{"application\/json":[{"itemId":102,"fileType":"jpeg","path":"documents\/image\/i10\/102-adipisci.jpeg","position":33,"createdAt":"2006-04-17T04:40:08+02:00","updatedAt":"2023-11-22T10:50:36+01:00","md5Checksum":"6cd919f737ededdf8780b6d9f7c9b35d"},{"itemId":102,"fileType":"jpeg","path":"documents\/image\/i10\/102-quos.jpeg","position":31,"createdAt":"1976-03-19T07:18:11+01:00","updatedAt":"1979-05-20T21:06:35+01:00","md5Checksum":"4d004897b6c573fbf480fb59064b5fee"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"itemId":102,"fileType":"jpg","path":"documents\/image\/i10\/102-inventore.jpg","position":47,"createdAt":"2009-07-09T10:25:30+02:00","updatedAt":"2009-08-09T18:09:56+02:00","md5Checksum":"d6a7b07439c7d034bed6817f44fda97b"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"itemId":102,"fileType":"jpeg","path":"documents\/image\/i10\/102-deserunt.jpeg","position":1,"createdAt":"2006-08-12T15:37:26+02:00","updatedAt":"2007-05-23T20:51:18+02:00","md5Checksum":"64c8a24cb5d159df19a13452291e559d"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"itemId":102,"fileType":"gif","path":"documents\/image\/i10\/102-aperiam.gif","position":4,"createdAt":"2007-01-27T08:55:55+01:00","updatedAt":"2018-03-25T05:58:38+02:00","md5Checksum":"cd24b4daaf058c21a721df3b8ab5c67e"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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","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","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","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"},"examples":{"application\/json":{"imageId":6,"type":"listing","value":6,"webstoreId":6}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"imageId":4,"type":"marketplace","value":8,"webstoreId":8}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"imageId":8,"lang":"mt","name":"ducimus"},{"imageId":5,"lang":"kl","name":"tempore"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"imageId":8,"lang":"ie","name":"aliquid"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"imageId":7,"lang":"rw","name":"est"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"imageId":8,"lang":"ar","name":"dolores"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"variationId":1003,"itemId":107,"imageId":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"itemId":10064,"crossItemId":10065,"isDynamic":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"itemId":10062,"crossItemId":10063,"isDynamic":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}]},"put":{"summary":"Update a cross-selling link","description":"Updates 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\/ItemCrossSelling"},"examples":{"application\/json":{"itemId":10066,"crossItemId":10067,"isDynamic":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/labels":{"post":{"summary":"Get a item label","description":"Gets a base64 encoded label for the specified item 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"}]}},"\/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"},"examples":{"application\/json":{"variationId":1008,"itemId":104,"imageId":5}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"itemId":104,"lang":"ru","name":"Mrs. Telly Stoltenberg V","metaDescription":"","description":"<\\p>Consectetur optio ipsum excepturi ullam. Unde rerum velit quos tempore praesentium autem perferendis. Eaque est corporis iste velit earum exercitationem magni.<\\\/\\p>","urlPath":"wohnzimmer\/sofas\/sofa-creme-classicline"},{"itemId":110,"lang":"ro","name":"Prof. Axel Murazik II","metaDescription":"","description":"<\\p>Atque ad dolore consequuntur aspernatur eos aspernatur. Rerum nihil dolorum ut rerum. Qui maiores illum eius necessitatibus. Quod ducimus laudantium aperiam distinctio.<\\\/\\p>","urlPath":"wohnzimmer\/sofas\/sofa-creme-classicline"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"itemId":106,"lang":"fr","name":"Leann Kertzmann","metaDescription":"","description":"<\\p>Delectus repellendus sit tenetur quaerat. Et voluptas esse possimus voluptas rerum hic fugiat ratione. Dolorum et et non aut. Voluptatem est dolor dolorum necessitatibus dolores culpa.<\\\/\\p>","urlPath":"wohnzimmer\/sofas\/sofa-creme-classicline"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"itemId":110,"lang":"vn","name":"Elody Howe Sr.","metaDescription":"","description":"<\\p>Qui quis ratione ea et quis. Laboriosam nostrum voluptatum sunt nostrum est. Eum voluptas autem culpa nesciunt consequatur eligendi esse.<\\\/\\p>","urlPath":"wohnzimmer\/sofas\/sofa-creme-classicline"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"itemId":108,"lang":"ga","name":"Albertha Buckridge","metaDescription":"","description":"<\\p>Eos error nihil eum aut illum. Doloribus tenetur consequatur quia quos. Non et impedit cum sit. Dolores in molestiae dolore esse recusandae pariatur.<\\\/\\p>","urlPath":"wohnzimmer\/sofas\/sofa-creme-classicline"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"itemId":102,"fileType":"jpeg","path":"documents\/image\/i10\/102-aperiam.jpeg","position":46,"createdAt":"2005-09-22T18:49:26+02:00","updatedAt":"2009-04-05T09:31:31+02:00","md5Checksum":"fe02f072359a17f1c50e829ec0000fc5"},{"itemId":102,"fileType":"jpeg","path":"documents\/image\/i10\/102-aspernatur.jpeg","position":41,"createdAt":"1984-06-02T06:25:34+02:00","updatedAt":"2020-05-08T19:42:57+02:00","md5Checksum":"cddfd696597d40fff1b4389493439bbc"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"variationId":99164,"countryId":14,"type":"EPID","position":3,"value":"sint"},{"variationId":99165,"countryId":7,"type":"ASIN","position":2,"value":"molestiae"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"variationId":99167,"countryId":7,"type":"EPID","position":3,"value":"qui"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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, MOIN"},"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"},"examples":{"application\/json":{"variationId":99166,"countryId":12,"type":"ASIN","position":4,"value":"magni"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"variationId":99168,"countryId":15,"type":"EPID","position":3,"value":"qui"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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, MOIN"},"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"}},"examples":{"application\/json":[{"itemId":372,"variationId":1182,"warehouseId":5,"reservedListing":0,"reservedBundles":0,"valueOfGoods":3363.2,"purchasePrice":84.08,"physicalStock":40,"reservedStock":1,"netStock":39,"reorderLevel":3,"deltaReorderLevel":-36},{"itemId":466,"variationId":3781,"warehouseId":4,"reservedListing":0,"reservedBundles":0,"valueOfGoods":4733.28,"purchasePrice":62.28,"physicalStock":76,"reservedStock":4,"netStock":72,"reorderLevel":4,"deltaReorderLevel":-68}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The properties to be loaded","format":"","in":"query","items":{"type":"string"}},{"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"}},"examples":{"application\/json":[{"itemId":990,"variationId":7523,"warehouseId":1,"reservedListing":0,"reservedBundles":0,"valueOfGoods":2856.84,"purchasePrice":50.12,"physicalStock":57,"reservedStock":5,"netStock":52,"reorderLevel":5,"deltaReorderLevel":-47},{"itemId":276,"variationId":7815,"warehouseId":6,"reservedListing":0,"reservedBundles":0,"valueOfGoods":6551.19,"purchasePrice":78.93,"physicalStock":83,"reservedStock":3,"netStock":80,"reorderLevel":2,"deltaReorderLevel":-78}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"itemId":802,"variationId":5268,"warehouseId":8,"reservedListing":0,"reservedBundles":0,"valueOfGoods":2358.15,"purchasePrice":29.85,"physicalStock":79,"reservedStock":4,"netStock":75,"reorderLevel":4,"deltaReorderLevel":-71},{"itemId":282,"variationId":3982,"warehouseId":7,"reservedListing":0,"reservedBundles":0,"valueOfGoods":579.9,"purchasePrice":19.33,"physicalStock":30,"reservedStock":4,"netStock":26,"reorderLevel":4,"deltaReorderLevel":-22}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"itemId":735,"variationId":1219,"warehouseId":9,"reservedListing":0,"reservedBundles":0,"valueOfGoods":2226.75,"purchasePrice":29.69,"physicalStock":75,"reservedStock":3,"netStock":72,"reorderLevel":2,"deltaReorderLevel":-70},{"itemId":986,"variationId":8696,"warehouseId":2,"reservedListing":0,"reservedBundles":0,"valueOfGoods":2928.3,"purchasePrice":97.61,"physicalStock":30,"reservedStock":3,"netStock":27,"reorderLevel":1,"deltaReorderLevel":-26}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"id":2075,"itemId":383,"variationId":6733,"warehouseId":3,"reasonString":"Wareneingang (WE)","attributeValues":"","processRowId":2094,"quantity":3,"reason":101,"createdAt":"2025-08-28T07:16:51+02:00","processRowType":1,"storageLocationName":"Default storage location","warehouseName":"Sales warehouse #3","purchasePrice":24.13,"userId":17,"batch":2514,"bestBeforeDate":"1989-09-29"},{"id":3381,"itemId":923,"variationId":9114,"warehouseId":9,"reasonString":"Wareneingang (WE)","attributeValues":"","processRowId":7881,"quantity":10,"reason":101,"createdAt":"2025-08-29T12:11:05+02:00","processRowType":1,"storageLocationName":"Default storage location","warehouseName":"Sales warehouse #9","purchasePrice":13.22,"userId":19,"batch":5743,"bestBeforeDate":"1999-02-02"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The properties to be loaded","format":"","in":"query","items":{"type":"string"}},{"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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"itemId":596,"variationId":1586,"storageLocationId":11,"warehouseId":14,"quantity":25,"updatedAt":"2025-08-12T04:15:10+02:00","storageLocation":[],"batch":"","bestBeforeDate":""},{"itemId":420,"variationId":1518,"storageLocationId":8,"warehouseId":12,"quantity":22,"updatedAt":"2025-08-31T21:54:57+02:00","storageLocation":[],"batch":"","bestBeforeDate":""}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","properties":{"reasonId":{"type":"integer","description":"The reason for the redistribution. Valid reasons are:\n\n 401: Stock transfer\n 402: Stock correction by stocktaking\n 403: 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"itemId":742,"variationId":5491,"storageLocationId":2,"warehouseId":11,"quantity":20,"updatedAt":"2025-08-19T19:39:32+02:00","storageLocation":[],"batch":"","bestBeforeDate":""},{"itemId":779,"variationId":4022,"storageLocationId":17,"warehouseId":4,"quantity":62,"updatedAt":"2025-08-19T12:10:42+02:00","storageLocation":[],"batch":"","bestBeforeDate":""}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The properties to be loaded","format":"","in":"query","items":{"type":"string"}},{"name":"sortBy","type":"string","required":false,"description":"The column to be sorted by","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"The sort direction","format":"string","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"}},"examples":{"application\/json":[{"variationId":1007,"marketId":189.08,"marketAccountId":59246,"sku":"DE57288335381505208618"},{"variationId":1003,"marketId":108.69,"marketAccountId":44499,"sku":"DE88035581933206445546"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"variationId":1004,"marketId":67.7,"marketAccountId":17077,"sku":"DE97089651421060307835"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"variationId":1003,"marketId":21.46,"marketAccountId":86018,"sku":"DE34580222302862674545"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"variationId":1006,"marketId":10.4,"marketAccountId":83006,"sku":"DE47603325670270589148"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"barcodeId":18,"variationId":99159,"code":"5268021954688"},{"barcodeId":19,"variationId":99160,"code":"7547308956231"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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: <ul><li>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"},"examples":{"application\/json":{"barcodeId":21,"variationId":99162,"code":"0173346951029"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"barcodeId":20,"variationId":99161,"code":"5562500442490"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"barcodeId":22,"variationId":99163,"code":"6672058557542"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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.\nThe 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"}},"examples":{"application\/json":[{"variationId":99185,"componentVariationId":99186,"componentQuantity":1},{"variationId":99187,"componentVariationId":99188,"componentQuantity":4}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"variationId":99195,"componentVariationId":99196,"componentQuantity":2}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"variationId":99193,"componentVariationId":99194,"componentQuantity":2}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"variationId":99197,"componentVariationId":99198,"componentQuantity":4}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"variationId":99181,"categoryId":33,"position":6,"isNeckermannPrimary":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"variationId":99183,"categoryId":35,"position":3,"isNeckermannPrimary":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"variationId":99182,"categoryId":34,"position":4,"isNeckermannPrimary":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"variationId":99184,"categoryId":36,"position":2,"isNeckermannPrimary":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"variationId":99169,"plentyId":10485},{"variationId":99170,"plentyId":14604}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"variationId":99171,"plentyId":13449}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"variationId":99189,"componentVariationId":99190,"componentQuantity":2},{"variationId":99191,"componentVariationId":99192,"componentQuantity":5}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"variationId":99172,"branchId":29,"plentyId":14875,"manually":"N"},{"variationId":99173,"branchId":30,"plentyId":10098,"manually":"N"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"variationId":99175,"branchId":32,"plentyId":14717,"manually":"Y"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"variationId":99174,"branchId":31,"plentyId":19865,"manually":"N"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"variationId":1002,"itemId":107,"imageId":5}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"variationId":1001,"itemId":106,"imageId":3}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"variationId":1005,"marketId":169.02},{"variationId":1001,"marketId":175}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"variationId":1000,"marketId":175}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"itemId":10117,"propertyId":29,"propertySelectionId":9,"valueInt":8,"valueFloat":8514250.484896,"valueFile":"7","surcharge":9,"variationId":null},{"itemId":10118,"propertyId":30,"propertySelectionId":10,"valueInt":9,"valueFloat":239451377.3,"valueFile":"4","surcharge":4,"variationId":null}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"itemId":10116,"propertyId":28,"propertySelectionId":8,"valueInt":7,"valueFloat":297608.63180947,"valueFile":"2","surcharge":9,"variationId":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"itemId":10119,"propertyId":31,"propertySelectionId":11,"valueInt":5,"valueFloat":173,"valueFile":"8","surcharge":1,"variationId":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"itemId":10120,"propertyId":32,"propertySelectionId":12,"valueInt":3,"valueFloat":7980723.6,"valueFile":"8","surcharge":9,"variationId":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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}\/deleteFile":{"delete":{"summary":"Delete file","description":"Deletes one file for specific characteristic","tags":["Item"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/VariationPropertyValue"},"examples":{"application\/json":{"itemId":10122,"propertyId":34,"propertySelectionId":14,"valueInt":4,"valueFloat":221972.0124695,"valueFile":"1","surcharge":3,"variationId":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/items\/{id}\/variations\/{variationId}\/variation_properties\/{propertyId}\/upload":{"post":{"summary":"Upload file","description":"Uploads one file for characteristics","tags":["Item"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/VariationPropertyValue"},"examples":{"application\/json":{"itemId":10121,"propertyId":33,"propertySelectionId":13,"valueInt":5,"valueFloat":5.15453,"valueFile":"5","surcharge":5,"variationId":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/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"}},"examples":{"application\/json":[{"variationId":99176,"salesPriceId":14,"price":371.96},{"variationId":99177,"salesPriceId":16,"price":89.99}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"variationId":99179,"salesPriceId":20,"price":199.67}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"lowestPrice":{"type":"number","description":"The lowest price of the variation saved for this sales price optional"},"lowestPriceCalculation":{"type":"boolean","description":"Is the lowest price calculation active for this sales price optional"}}}}]}},"\/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"},"examples":{"application\/json":{"variationId":99178,"salesPriceId":18,"price":690.55}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"variationId":99180,"salesPriceId":22,"price":957.83}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"lowestPrice":{"type":"number","description":"The lowest price of the variation saved for this sales price optional"},"lowestPriceCalculation":{"type":"boolean","description":"Is the lowest price calculation active for this sales price optional"}}}}]}},"\/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"}},"examples":{"application\/json":[{"id":91487,"variationId":1097,"marketId":101,"accountId":9,"initialSku":"28014","sku":"28014","parentSku":"250","isActive":false,"status":"INACTIVE","createdAt":"1989-10-18T11:54:07+01:00","exportedAt":"2016-02-02T14:38:01+01:00","stockUpdatedAt":"1974-09-14T12:33:14+01:00","deletedAt":null,"additionalInformation":"qui"},{"id":39518,"variationId":1055,"marketId":146,"accountId":1,"initialSku":"99502","sku":"99502","parentSku":"999","isActive":false,"status":"INACTIVE","createdAt":"2014-01-19T01:33:37+01:00","exportedAt":"1976-04-09T23:53:55+01:00","stockUpdatedAt":"2000-03-27T23:34:52+02:00","deletedAt":null,"additionalInformation":"laboriosam"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"id":93837,"variationId":1038,"marketId":133,"accountId":5,"initialSku":"27968","sku":"27968","parentSku":"948","isActive":false,"status":"ERROR","createdAt":"2014-03-15T02:40:45+01:00","exportedAt":"1984-06-25T01:15:41+02:00","stockUpdatedAt":"2003-08-28T01:11:13+02:00","deletedAt":null,"additionalInformation":"impedit"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"id":42667,"variationId":1057,"marketId":136,"accountId":9,"initialSku":"78673","sku":"78673","parentSku":"465","isActive":false,"status":"ERROR","createdAt":"1973-06-14T08:54:59+01:00","exportedAt":"2020-06-15T20:43:28+02:00","stockUpdatedAt":"2017-01-09T15:54:06+01:00","deletedAt":null,"additionalInformation":"facere"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"id":86325,"variationId":1058,"marketId":148,"accountId":3,"initialSku":"29275","sku":"29275","parentSku":"153","isActive":false,"status":"ERROR","createdAt":"1985-08-22T19:07:41+02:00","exportedAt":"1994-11-18T16:07:51+01:00","stockUpdatedAt":"1981-03-05T20:39:13+01:00","deletedAt":null,"additionalInformation":"nulla"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"warehouseId":237,"variationId":99199,"zoneId":5,"storageLocationType":"medium","reorderLevel":6,"maximumStock":1,"stockTurnoverInDays":1,"storageLocation":1,"stockBuffer":2,"isBatch":false,"isBestBeforeDate":true},{"warehouseId":239,"variationId":99200,"zoneId":8,"storageLocationType":"small","reorderLevel":9,"maximumStock":6,"stockTurnoverInDays":5,"storageLocation":4,"stockBuffer":9,"isBatch":true,"isBestBeforeDate":false}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"warehouseId":243,"variationId":99202,"zoneId":1,"storageLocationType":"medium","reorderLevel":5,"maximumStock":1,"stockTurnoverInDays":1,"storageLocation":7,"stockBuffer":5,"isBatch":true,"isBestBeforeDate":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"warehouseId":241,"variationId":99201,"zoneId":9,"storageLocationType":"none","reorderLevel":2,"maximumStock":9,"stockTurnoverInDays":8,"storageLocation":1,"stockBuffer":3,"isBatch":false,"isBestBeforeDate":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"warehouseId":245,"variationId":99203,"zoneId":2,"storageLocationType":"medium","reorderLevel":4,"maximumStock":1,"stockTurnoverInDays":9,"storageLocation":9,"stockBuffer":5,"isBatch":false,"isBestBeforeDate":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"storeSpecial":2,"stockType":2,"ownerId":9,"manufacturerId":2,"producingCountryId":8,"revenueAccount":8,"couponRestriction":2,"condition":1,"conditionApi":3,"createdAt":"2024-11-10T05:43:16+01:00","updatedAt":"2025-03-06T11:25:23+01:00","isSubscribable":false,"isSerialNumber":false,"isShippingPackage":false,"amazonFbaPlatform":1,"isShippableByAmazon":true,"amazonFedas":"alias","ebayPresetId":8,"ebayCategory":1,"ebayCategory2":9,"ebayStoreCategory":3,"ebayStoreCategory2":9,"rakutenCategoryId":4,"flagOne":25,"flagTwo":2,"ageRestriction":12,"feedback":5,"maximumOrderQuantity":11,"mainVariationId":null,"crossSellingCharacteristicId":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 <a href='https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#countries' target='_blank'>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"},"examples":{"application\/json":{"storeSpecial":3,"stockType":1,"ownerId":10,"manufacturerId":2,"producingCountryId":9,"revenueAccount":8,"couponRestriction":1,"condition":2,"conditionApi":3,"createdAt":"2025-08-06T06:06:33+02:00","updatedAt":"2025-06-22T13:03:44+02:00","isSubscribable":true,"isSerialNumber":true,"isShippingPackage":false,"amazonFbaPlatform":2,"isShippableByAmazon":true,"amazonFedas":"asperiores","ebayPresetId":8,"ebayCategory":3,"ebayCategory2":4,"ebayStoreCategory":3,"ebayStoreCategory2":9,"rakutenCategoryId":8,"flagOne":11,"flagTwo":7,"ageRestriction":6,"feedback":3,"maximumOrderQuantity":63,"mainVariationId":null,"crossSellingCharacteristicId":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","properties":{"position":{"type":"integer","description":"The position of the item optional"},"stockType":{"type":"integer","description":"The stock type of the item. Possible values:\n0 = Stocked item (default)\n 1 = Production item\n 2 = Colli\n 3 = 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.\n1 = 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;\nusually a 11 digit code number based on the Harmonised System optional"},"revenueAccount":{"type":"integer","description":"The revenue account the item is linked to.\nAn individual revenue account can be saved for each item in plentymarkets.\nIf this is not done, plentymarkets automatically determines a revenue account\nbased on the VAT rate. optional"},"couponRestriction":{"type":"integer","description":"Indicates if the item can be purchased using a promotional coupon.\n0 = Permitted\n 1 = Not permitted\n 2 = Purchasable with coupon only optional allowed values are 0, 1, 2"},"condition":{"type":"integer","description":"The condition of the item. Possible values:\n0 = New1 = Used\n 2 = Boxed as new\n 3 = New with label\n 4 = 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.\n0 = New\n 1 = Used but as new\n 2 = Used but very good\n 3 = Used but good\n 4 = Used but acceptable\n 5 = 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.\nIf 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.\nIf yes and the variation's dimensions are entered in the Settings tab of a\nvariation, the correct shipping package is assigned automatically. optional"},"amazonFbaPlatform":{"type":"integer","description":"Indicates the platform used for Fulfilment by Amazon (FBA).\n0 = Do not use\n 1 = AMAZON EU (Europe)\n 2 = AMAZON FE (Far East)\n 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.\nAmazon Multi-Channel Fulfillment is a service for fulfilling orders from sales\nchannels other than Amazon platforms using inventory stored in the Amazon\nfulfillment center. optional"},"amazonProductType":{"type":"integer","description":"The Amazon product type of the item (deprecated as of June 2025). List of IDs:\nhttps:\/\/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\n$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.\nThis value is used for new listings. optional"},"ebayStoreCategory2":{"type":"integer","description":"The ID of the eBay store category 2 of the item.\nThis 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.\nEach 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.\nEach 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.\nItems with an age rating of 18+ must be linked to a shipping profile for which the\nPostIdent option is activated.\n0 = None available\n 3 = Released for ages 3 and up\n 6 = Ages 6 and up\n 9 = Ages 9 and up\n 12 = Ages 12 and up\n 14 = Ages 14 and up\n 16 = Ages 16 and up\n 18 = Ages 18 and up\n 50 = Not marked\n 88 = Not \n 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.\nPossible values are 1 to 5 or 1 to 10 depending on the maximum rating setting.\nAn initial feedback can be saved for items. The saved value will then be displayed as the\ninitial feedback. Every time new feedback is submitted, the average value will be\nrecalculated automatically. optional"},"itemType":{"type":"string","description":"The type of the item. Because Set items are managed using a separate route,\nthis value is always Default. optional allowed values are default, multiPack, set"},"ebayTitles":{"type":"array","items":{"$ref":"#\/definitions\/ItemEbayTitle"}},"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}\/copy":{"post":{"summary":"Copies an item","description":"Copies an item and its variations. The ID of the item must be specified.","tags":["Item"],"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":"itemId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/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"}},"examples":{"application\/json":[{"itemId":10113,"profileId":16},{"itemId":10114,"profileId":17}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"itemId":10115,"profileId":18}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"isMain":false,"mainVariationId":null,"itemId":10057,"position":55,"isActive":true,"number":"C-284784","unitCombinationId":77,"model":"qui","externalId":null,"availability":1,"estimatedAvailableAt":"2025-09-21T00:00:00+02:00","purchasePrice":89.4,"createdAt":"2025-06-10T16:48:18+02:00","updatedAt":"2025-08-27T12:42:07+02:00","relatedUpdatedAt":"2025-09-02T04:04:37+02:00","priceCalculationId":null,"picking":"no_single_picking","stockLimitation":2,"isVisibleIfNetStockIsPositive":false,"isInvisibleIfNetStockIsNotPositive":false,"isAvailableIfNetStockIsPositive":true,"isUnavailableIfNetStockIsNotPositive":false,"mainWarehouseId":192,"maximumOrderQuantity":59.62,"minimumOrderQuantity":38.95,"intervalOrderQuantity":19.59,"availableUntil":"2025-09-23T00:00:00+02:00","releasedAt":"2025-09-02T00:00:00+02:00","name":"beverly56","weightG":2,"weightNetG":7,"widthMM":6,"lengthMM":1,"heightMM":9,"extraShippingCharge1":53.77,"extraShippingCharge2":84.79,"unitsContained":3,"palletTypeId":5,"packingUnits":1,"packingUnitTypeId":6,"transportationCosts":81.44,"storageCosts":69.72,"customs":39.28,"operatingCosts":52.07,"vatId":1,"bundleType":"bundle_item","automaticClientVisibility":0,"isHiddenInCategoryList":true,"categoryVariationId":0,"marketVariationId":0,"clientVariationId":0,"salesPriceVariationId":0,"supplierVariationId":0,"warehouseVariationId":0,"propertyVariationId":0,"tagVariationId":0,"salesRank":null},{"isMain":false,"mainVariationId":null,"itemId":10058,"position":85,"isActive":true,"number":"Q-286090","unitCombinationId":78,"model":"et","externalId":null,"availability":1,"estimatedAvailableAt":"2025-09-20T00:00:00+02:00","purchasePrice":97.8,"createdAt":"2024-10-22T11:10:40+02:00","updatedAt":"2025-08-31T06:47:52+02:00","relatedUpdatedAt":"2025-08-28T22:13:54+02:00","priceCalculationId":null,"picking":null,"stockLimitation":0,"isVisibleIfNetStockIsPositive":true,"isInvisibleIfNetStockIsNotPositive":true,"isAvailableIfNetStockIsPositive":false,"isUnavailableIfNetStockIsNotPositive":true,"mainWarehouseId":193,"maximumOrderQuantity":62.54,"minimumOrderQuantity":37.95,"intervalOrderQuantity":23.67,"availableUntil":"2025-09-21T00:00:00+02:00","releasedAt":"2025-08-28T00:00:00+02:00","name":"zane61","weightG":5,"weightNetG":9,"widthMM":1,"lengthMM":8,"heightMM":1,"extraShippingCharge1":49.01,"extraShippingCharge2":38.08,"unitsContained":8,"palletTypeId":3,"packingUnits":2,"packingUnitTypeId":8,"transportationCosts":27.17,"storageCosts":58.91,"customs":23.45,"operatingCosts":32.67,"vatId":1,"bundleType":"bundle_item","automaticClientVisibility":0,"isHiddenInCategoryList":true,"categoryVariationId":0,"marketVariationId":0,"clientVariationId":0,"salesPriceVariationId":0,"supplierVariationId":0,"warehouseVariationId":0,"propertyVariationId":0,"tagVariationId":0,"salesRank":null}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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: <ul><li>properties<\/b> = The properties linked to the variation<\/li><li>variationProperties<\/b> = The properties linked to the variation<\/li><li>variationBarcodes<\/b> = The barcode linked to the variation and the saved code<\/li><li>variationBundleComponents<\/b> = The bundle components of the variation and their quantities<\/li><li>variationComponentBundles<\/b> = The bundles that this variation is a component of<\/li><li>variationSalesPrices<\/b> = The sales prices linked to the variation and the saved price<\/li><li>marketItemNumbers<\/b> = The market ident number of the variation<\/li><li>variationCategories<\/b> = The categories linked to the variation<\/li><li>variationClients<\/b> = The clients (stores) for which the variation is activated<\/li><li>variationMarkets<\/b> = The markets for which the variation is activated <\/li><li>variationDefaultCategory<\/b> = The default category of the variation<\/li><li>variationSuppliers<\/b> = The supplier data associated with the variation<\/li><li>variationWarehouses<\/b> = The warehouse data associated with the variation<\/li><li>images<\/b> = The images linked to the variation<\/li><li>itemImages<\/b> = The images linked to the item<\/li><li>variationAttributeValues<\/b> = The attribute values of the variation<\/li><li>variationSkus<\/b> = The SKU data associated with the variation<\/li><li>variationAdditionalSkus<\/b> = The additional SKU data associated with the variation<\/li><li>unit<\/b> = The unit assigned to the variation<\/li><li>parent<\/b> = The main variation of the variation. Value is null if this variation is the item's main variation.<\/li><li>item<\/b> = The item of the variation<\/li><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 <a href='https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#countries' target='_blank'>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"},"examples":{"application\/json":{"isMain":false,"mainVariationId":null,"itemId":10059,"position":89,"isActive":true,"number":"D-697057","unitCombinationId":79,"model":"excepturi","externalId":null,"availability":1,"estimatedAvailableAt":"2025-09-17T00:00:00+02:00","purchasePrice":66.44,"createdAt":"2025-08-27T10:51:18+02:00","updatedAt":"2025-08-28T16:12:33+02:00","relatedUpdatedAt":"2025-08-29T16:03:09+02:00","priceCalculationId":null,"picking":null,"stockLimitation":2,"isVisibleIfNetStockIsPositive":true,"isInvisibleIfNetStockIsNotPositive":true,"isAvailableIfNetStockIsPositive":true,"isUnavailableIfNetStockIsNotPositive":false,"mainWarehouseId":194,"maximumOrderQuantity":95.52,"minimumOrderQuantity":23.64,"intervalOrderQuantity":43.21,"availableUntil":"2025-09-20T00:00:00+02:00","releasedAt":"2025-08-31T00:00:00+02:00","name":"kstoltenberg","weightG":9,"weightNetG":7,"widthMM":2,"lengthMM":5,"heightMM":6,"extraShippingCharge1":95.19,"extraShippingCharge2":13.86,"unitsContained":2,"palletTypeId":7,"packingUnits":4,"packingUnitTypeId":8,"transportationCosts":90.54,"storageCosts":88.39,"customs":62.37,"operatingCosts":18.52,"vatId":2,"bundleType":null,"automaticClientVisibility":0,"isHiddenInCategoryList":true,"categoryVariationId":0,"marketVariationId":0,"clientVariationId":0,"salesPriceVariationId":0,"supplierVariationId":0,"warehouseVariationId":0,"propertyVariationId":0,"tagVariationId":0,"salesRank":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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":"string","description":"The ID of the price calculation linked to the variation. (deprecated) 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"},"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"},"examples":{"application\/json":{"isMain":false,"mainVariationId":null,"itemId":10055,"position":83,"isActive":true,"number":"I-979944","unitCombinationId":75,"model":"sed","externalId":null,"availability":1,"estimatedAvailableAt":"2025-09-21T00:00:00+02:00","purchasePrice":77.28,"createdAt":"2025-06-29T05:45:35+02:00","updatedAt":"2025-08-28T01:09:32+02:00","relatedUpdatedAt":"2025-08-29T12:51:23+02:00","priceCalculationId":null,"picking":"single_picking","stockLimitation":1,"isVisibleIfNetStockIsPositive":true,"isInvisibleIfNetStockIsNotPositive":false,"isAvailableIfNetStockIsPositive":true,"isUnavailableIfNetStockIsNotPositive":false,"mainWarehouseId":190,"maximumOrderQuantity":92.53,"minimumOrderQuantity":7.58,"intervalOrderQuantity":71.48,"availableUntil":"2025-09-24T00:00:00+02:00","releasedAt":"2025-08-31T00:00:00+02:00","name":"cruz18","weightG":7,"weightNetG":2,"widthMM":2,"lengthMM":6,"heightMM":3,"extraShippingCharge1":61.44,"extraShippingCharge2":4.87,"unitsContained":8,"palletTypeId":8,"packingUnits":6,"packingUnitTypeId":3,"transportationCosts":59.81,"storageCosts":82.84,"customs":3.17,"operatingCosts":97.56,"vatId":1,"bundleType":"bundle_item","automaticClientVisibility":1,"isHiddenInCategoryList":false,"categoryVariationId":0,"marketVariationId":0,"clientVariationId":0,"salesPriceVariationId":0,"supplierVariationId":0,"warehouseVariationId":0,"propertyVariationId":0,"tagVariationId":0,"salesRank":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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: <ul><li>properties<\/b> = The properties linked to the variation<\/li><li>variationProperties<\/b> = The properties linked to the variation<\/li><li>variationBarcodes<\/b> = The barcode linked to the variation and the saved code<\/li><li>variationBundleComponents<\/b> = The bundle components of the variation and their quantities<\/li><li>variationComponentBundles<\/b> = The bundles that this variation is a component of<\/li><li>variationSalesPrices<\/b> = The sales prices linked to the variation and the saved price<\/li><li>marketItemNumbers<\/b> = The market ident number of the variation<\/li><li>variationCategories<\/b> = The categories linked to the variation<\/li><li>variationClients<\/b> = The clients (stores) for which the variation is activated<\/li><li>variationMarkets<\/b> = The markets for which the variation is activated <\/li><li>variationDefaultCategory<\/b> = The default category of the variation<\/li><li>variationSuppliers<\/b> = The supplier data associated with the variation<\/li><li>variationWarehouses<\/b> = The warehouse data associated with the variation<\/li><li>images<\/b> = The images linked to the variation<\/li><li>itemImages<\/b> = The images linked to the item<\/li><li>variationAttributeValues<\/b> = The attribute values of the variation<\/li><li>variationSkus<\/b> = The SKU data associated with the variation<\/li><li>variationAdditionalSkus<\/b> = The additional SKU data associated with the variation<\/li><li>unit<\/b> = The unit assigned to the variation<\/li><li>parent<\/b> = The main variation of the variation. Value is null if this variation is the item's main variation.<\/li><li>item<\/b> = The item of the variation<\/li><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"},"examples":{"application\/json":{"isMain":false,"mainVariationId":null,"itemId":10056,"position":2,"isActive":false,"number":"R-764649","unitCombinationId":76,"model":"nihil","externalId":null,"availability":1,"estimatedAvailableAt":"2025-09-18T00:00:00+02:00","purchasePrice":59.79,"createdAt":"2024-11-18T08:37:13+01:00","updatedAt":"2025-08-31T01:57:27+02:00","relatedUpdatedAt":"2025-09-03T09:21:43+02:00","priceCalculationId":null,"picking":"exclude_from_picklist","stockLimitation":1,"isVisibleIfNetStockIsPositive":false,"isInvisibleIfNetStockIsNotPositive":true,"isAvailableIfNetStockIsPositive":false,"isUnavailableIfNetStockIsNotPositive":false,"mainWarehouseId":191,"maximumOrderQuantity":71.12,"minimumOrderQuantity":34.13,"intervalOrderQuantity":20.11,"availableUntil":"2025-09-19T00:00:00+02:00","releasedAt":"2025-08-29T00:00:00+02:00","name":"mmetz","weightG":9,"weightNetG":1,"widthMM":2,"lengthMM":5,"heightMM":2,"extraShippingCharge1":90.77,"extraShippingCharge2":18.76,"unitsContained":8,"palletTypeId":5,"packingUnits":1,"packingUnitTypeId":6,"transportationCosts":84,"storageCosts":30.87,"customs":46.71,"operatingCosts":15.52,"vatId":2,"bundleType":"bundle","automaticClientVisibility":1,"isHiddenInCategoryList":true,"categoryVariationId":0,"marketVariationId":0,"clientVariationId":0,"salesPriceVariationId":0,"supplierVariationId":0,"warehouseVariationId":0,"propertyVariationId":0,"tagVariationId":0,"salesRank":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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":"string","description":"The ID of the price calculation linked to the variation. (deprecated) 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"},"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":{}},"variationProperties":{"type":"array","items":{"$ref":"#\/definitions\/VariationPropertyValue"}},"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"},"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","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","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"},"examples":{"application\/json":{"pluginSetId":1,"pluginName":"Shopify","languageCode":"en","key":"Numquam quos.","value":"A."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"pluginSetId":1,"pluginName":"Shopify","languageCode":"en","key":"Harum.","value":"Est."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"pluginSetId":1,"pluginName":"Shopify","languageCode":"en","key":"Vitae nulla.","value":"Et."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/all\/{plentyId}\/{lang}":{"get":{"summary":"Return ALL legal texts","description":"Return legal texts of all types","tags":["LegalInformation"],"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":"plentyId","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"name":"lang","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"post":{"summary":"update the text in the plenty_text table","description":"if we send only plainText it will be saved in htmlText","tags":["LegalInformation"],"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":"plentyId","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"name":"lang","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","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, fi, ga, lt, lv, et, hr, hu"},"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, DeclarationOfAccessibility"},"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":{"$ref":"#\/definitions\/PaginatedResult"},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"properties":[{"listingId":null,"typeId":10,"value":"N"},{"listingId":null,"typeId":11,"value":"1"},{"listingId":null,"typeId":12,"value":"none"}],"itemId":4,"unitCombinationId":1,"typeId":1,"stockDependenceTypeId":2},{"properties":[{"listingId":null,"typeId":10,"value":"N"},{"listingId":null,"typeId":11,"value":"1"},{"listingId":null,"typeId":12,"value":"none"}],"itemId":10,"unitCombinationId":1,"typeId":1,"stockDependenceTypeId":1}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"An array with child instances to be loaded. One of 'stockDependenceType', 'type', 'markets', 'properties'.","format":"","in":"query","items":{"type":"string"}}]},"post":{"summary":"Create new listing","description":"Creates a new listing.","tags":["Listing"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Listing"},"examples":{"application\/json":{"properties":[{"listingId":null,"typeId":10,"value":"N"},{"listingId":null,"typeId":11,"value":"1"},{"listingId":null,"typeId":12,"value":"none"}],"itemId":6,"unitCombinationId":1,"typeId":2,"stockDependenceTypeId":3}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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"},"examples":{"application\/json":{"additionalContent":[],"name":"Test layout template","css":"h1\\n{\\n\\tfont-weight: bold;\\n}","htmlStructure":"<html>\\r\\n\\t<head>\\r\\n\\t\\t<meta charset=\\\"UTF-8\\\">\\r\\n\\t\\t<title>$ListingTitle<\/title>\\r\\n\\t\\t{% GetCSSFile() %}\\r\\n\\t\\r\\n\\t<\/head>\\r\\n\\t<body>\\r\\n\\t\\t$MainFrame\\r\\n\\t<\/body>\\r\\n<\/html>","mainFrame":"<div>\\n\\t<h1>Test<\/h1>\\n<\/div>","appendixType":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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"},"examples":{"application\/json":{"additionalContent":[],"name":"Test layout template","css":"h1\\n{\\n\\tfont-weight: bold;\\n}","htmlStructure":"<html>\\r\\n\\t<head>\\r\\n\\t\\t<meta charset=\\\"UTF-8\\\">\\r\\n\\t\\t<title>$ListingTitle<\/title>\\r\\n\\t\\t{% GetCSSFile() %}\\r\\n\\t\\r\\n\\t<\/head>\\r\\n\\t<body>\\r\\n\\t\\t$MainFrame\\r\\n\\t<\/body>\\r\\n<\/html>","mainFrame":"<div>\\n\\t<h1>Test<\/h1>\\n<\/div>","appendixType":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":{"$ref":"#\/definitions\/PaginatedResult"},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"properties":[],"prices":[],"dates":[],"referrerId":125,"listingId":4,"variationId":9,"credentialsId":9},{"properties":[],"prices":[],"dates":[],"referrerId":104,"listingId":8,"variationId":6,"credentialsId":3}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"number","required":false,"description":"Filter that restricts the search result to listing markets with given referrer ID.","format":"number","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 <ul>\n <li>1 - Auction<\/li>\n <li>2 - Fixed price<\/li>\n <li>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 <ul>\n <li>1 - Unlimited stock with automatic synchronisation<\/li>\n <li>2 - Limited and reserved stock<\/li>\n <li>3 - Limited and unreserved stock<\/li>\n <li>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":"array","required":false,"description":"An array with child instances to be loaded. Valid instances are 'listing', 'texts', 'properties', 'prices', 'dates', 'infos'.","format":"","in":"query","items":{"type":"string"}}]},"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"}},"examples":{"application\/json":[{"properties":[],"prices":[],"dates":[],"referrerId":104,"listingId":5,"variationId":2,"credentialsId":2},{"properties":[],"prices":[],"dates":[],"referrerId":2.08,"listingId":8,"variationId":2,"credentialsId":5}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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"}},"examples":{"application\/json":[{"name":"Test_Test","parentId":1,"level":1},{"name":"Test_Test","parentId":1,"level":1}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"name":"Test_Test","parentId":1,"level":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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"},"examples":{"application\/json":{"name":"Test_Test","parentId":1,"level":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"name":"Test_Test","parentId":1,"level":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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":{"$ref":"#\/definitions\/PaginatedResult"},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"properties":[],"prices":[],"dates":[],"referrerId":125,"listingId":8,"variationId":5,"credentialsId":2},{"properties":[],"prices":[],"dates":[],"referrerId":125,"listingId":10,"variationId":2,"credentialsId":4}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"number","required":false,"description":"Filter that restricts the search result to listing markets with given referrer ID.","format":"number","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":"array","required":false,"description":"An array with child instances to be loaded. Valid instances are 'listing', 'texts', 'properties', 'prices', 'dates', 'infos'.","format":"","in":"query","items":{"type":"string"}}]}},"\/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":{"$ref":"#\/definitions\/PaginatedResult"},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"properties":[],"dates":[],"variations":[],"texts":[],"listingMarket":null,"currency":"","listingMarketId":137,"referrerId":[2.08],"externalId":"110189750971","quantity":50,"quantityRemain":49,"quantitySold":1,"quantitySoldDelta":0,"statusId":1,"price":16.82,"sku":"#MLID#137"},{"properties":[],"dates":[],"variations":[],"texts":[],"listingMarket":null,"currency":"","listingMarketId":137,"referrerId":[104],"externalId":"110189750971","quantity":50,"quantityRemain":49,"quantitySold":1,"quantitySoldDelta":0,"statusId":1,"price":23.39,"sku":"#MLID#137"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"number","required":false,"description":"Filter that restricts the search result to listing market histories with given referrer ID.","format":"number","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 <ul>\n <li>1 - Auction<\/li>\n <li>2 - Fixed price<\/li>\n <li>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 <ul>\n <li>1 - Unlimited stock with automatic synchronisation<\/li>\n <li>2 - Limited and reserved stock<\/li>\n <li>3 - Limited and unreserved stock<\/li>\n <li>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 <ul>\n <li>1 - Active listing market histories<\/li>\n <li>2 - Ended listing market histories<\/li>\n <li>3 - Relisted listing market histories<\/li>\n <li>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":"array","required":false,"description":"An array with child instances to be loaded. Valid instances are 'listingMarket', 'texts', 'properties', 'prices', 'dates'.","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/listings\/markets\/histories\/end\/{id}":{"delete":{"summary":"End the listing","description":"Ends the listing on the designated market.","tags":["Listing"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":{"affectedRows":22}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 that needs to be ended. This must be passed as an array. This parameter is only needed if more than one listing market history should be ended.","format":"integer","in":"path"},{"name":"deleteOnSuccess","type":"boolean","required":false,"description":"Tells if the listing market history should also be deleted from the database.","format":"boolean","in":"query"}]}},"\/rest\/listings\/markets\/histories\/relist\/{id}":{"post":{"summary":"Relist the listing","description":"Relists the listing on the designated market.","tags":["Listing"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":{"affectedRows":8}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 that needs to be relisted. This must be passed as an array. This parameter is only needed if more than one listing market history should be relisted.","format":"integer","in":"path"}]}},"\/rest\/listings\/markets\/histories\/update\/{id}":{"put":{"summary":"Update listing market histories","description":"Updates listing market histories by given update options. The listing market histories are not directly revised,\nthey are added to the batch processing lists, waiting to be revised by automated background processes.","tags":["Listing"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":{"createdJobIds":[123,124,125]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":true,"description":"The ID of the listing market history that needs to be updated. This must be passed as an array. This parameter is only needed if more than one listing market history should be updated.","format":"","in":"path","items":{"type":"integer"}},{"name":"options","type":"array","required":false,"description":"Multiple update options. Available values are:\n <ul>\n <li>all - Updates everything\n <li>title - Updates the title\n <li>subtitle - Updates the subtitle<\/li><\/li>\n <li>itemSpecifics - Updates the item specifics<\/li>\n <li>category - Updates the platform and shop category<\/li>\n <li>listingDetails - Updates listing details<\/li>\n <li>enhancements - Updates the enhancements information<\/li>\n <li>duration - Updates the duration<\/li>\n <li>shipping - Updates the shipping information<\/li>\n <li>description - Updates the description<\/li>\n <li>pictures - Updates the entry pictures<\/li>\n <li>quantityAndPrice - Updates the quantity and price (also for variations)<\/li>\n <li>resetVariations - Reset the variations. The variations from the item are transmitted again<\/li>\n <li>partsFitmentList - Updates the parts fitment information (only available for eBay)<\/li>\n <li>loyaltyProgram - Updates the listing loyalty program information (only available for eBay Plus)<\/li>\n <li>resetRrp - Reset the recommended retail price information (only available for eBay)<\/li>\n <li>payment - Updates payment information (only available for Hood)<\/li>\n <\/ul>","format":"","in":"query","items":{"type":"string"}}]}},"\/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"},"examples":{"application\/json":{"properties":[],"dates":[],"variations":[],"texts":[],"listingMarket":null,"currency":"","listingMarketId":137,"referrerId":[2.08],"externalId":"110189750971","quantity":50,"quantityRemain":49,"quantitySold":1,"quantitySoldDelta":0,"statusId":1,"price":3.01,"sku":"#MLID#137"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"An array with child instances to be loaded. One of 'listingMarket', 'texts', 'properties', 'dates', 'variations'.","format":"","in":"query","items":{"type":"string"}}]}},"\/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":{"$ref":"#\/definitions\/PaginatedResult"},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"listingMarketId":null,"type":"error","code":6895,"message":"Some message","createdAt":"1970-01-01T01:00:00+01:00"},{"listingMarketId":null,"type":"error","code":941108457,"message":"Some message","createdAt":"1970-01-01T01:00:00+01:00"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"An array with child instances to be loaded.","format":"","in":"query","items":{"type":"string"}}]}},"\/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":{"$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":[{"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","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\/start\/{id}":{"post":{"summary":"Start the market listing on the designated market.","description":"Starts the market listing on the designated markets.","tags":["Listing"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":{"affectedRows":22}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 that needs to be started. This can also be passed as an array.","format":"integer","in":"path"},{"name":"startAt","type":"string","required":false,"description":"When should the listings be started. The date has to be in the format, e.g. '2019-04-04 12:40:00'.","format":"string","in":"query"},{"name":"distribution","type":"integer","required":false,"description":"The number of minutes that the listing should be started.","format":"integer","in":"query"}]}},"\/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":{"$ref":"#\/definitions\/PaginatedResult"},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"lang":"de","title":"Beatae quo vero qui voluptates tempora placeat ipsum.","subtitle":"Sint consequuntur eos commodi.","description":"Dolores nostrum magnam iste perspiciatis in sed sapiente. Quia ducimus quia veritatis omnis. Praesentium quibusdam vel illo qui. Autem voluptate quo assumenda culpa. Numquam molestiae aut qui molestias aut libero. Esse amet autem possimus nobis magni. Eaque voluptas amet eaque debitis dignissimos. Sint consectetur facere in aperiam. Earum sed aspernatur nostrum ut velit est sunt. Veniam unde fuga quis omnis est dolorum. Eaque dicta modi voluptate ullam modi. Eveniet praesentium laborum omnis et accusantium totam. Et ut quis debitis alias dicta quae repudiandae. Laboriosam facere molestias quas sit. Eveniet ullam quis illum sit. Suscipit culpa qui fuga tempora. Fuga nostrum rerum quam ipsum. Velit dolorem enim nobis. Voluptas sequi omnis adipisci esse eaque perspiciatis. Architecto veniam veritatis nam esse hic. Delectus quae eos nihil corporis cum. Eius beatae et et et sed iusto impedit. Dicta enim unde eveniet est minus. Consequatur facilis voluptas et natus fugit libero."},{"lang":"fr","title":"Blanditiis officiis quae vel iusto non aliquid.","subtitle":"Illo et ut consequatur.","description":"Quis facilis nulla dolor dignissimos enim officiis. Officia sit atque qui sed non. Ut quo saepe et. Veritatis quia placeat maiores eligendi est. Blanditiis qui omnis ab facere asperiores et. Consequatur voluptates sit quaerat enim rerum aut minus. Similique laboriosam amet iusto vel nulla perspiciatis officiis. Consequatur perferendis animi eum dolorem enim illum. Deleniti nobis consequuntur minus dolorem ut. Ut laudantium aut magni facilis sapiente. Necessitatibus voluptates vel est voluptatem eum. Culpa nisi adipisci et ut cumque magnam laboriosam. Quia assumenda voluptatem itaque sed aliquid nostrum. Nisi dolor et culpa animi molestiae veniam ipsa. Ut asperiores ipsam qui error vero sed natus omnis. Delectus deleniti omnis ipsam ea nam sit. Quidem sint officia vero aspernatur eum. Voluptas exercitationem nulla iusto quod earum quo nam. Eius explicabo ab sint ea."}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"lang":"sk","title":"Voluptas quia ratione vel error debitis aliquam culpa.","subtitle":"Culpa voluptate assumenda delectus.","description":"Sequi labore culpa quia tempora necessitatibus reprehenderit et. Ipsam asperiores sed dolores sunt qui. Doloribus officia sint quas tenetur qui. Voluptatibus sunt voluptas sapiente perferendis qui at dicta. Laboriosam dolore ut nesciunt sit. Rerum reiciendis corrupti blanditiis ut molestiae. Eligendi nihil repellat explicabo ea rerum earum. Est aut dicta voluptatem dolor harum. Fugiat consectetur iure consectetur eveniet quia consequatur. Sit doloremque dolor aut laborum. Perferendis qui sed incidunt dolor suscipit necessitatibus. Earum voluptatibus ipsam corporis et. Quidem voluptatem voluptatem nobis esse. Recusandae fugiat et aut pariatur molestiae. Reprehenderit est quae ut accusantium necessitatibus maxime qui. Est odio vel et illo eaque sint quae. Quibusdam nemo iste qui similique consequuntur. Enim omnis reiciendis deleniti ipsum. Earum nisi nemo suscipit id non at voluptatum. Voluptatem saepe necessitatibus distinctio."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"lang":"da","title":"Enim ad optio quis voluptas atque.","subtitle":"Aut non quo.","description":"Architecto inventore iure libero sunt. Ipsam expedita totam quia illum. Ducimus ut nisi vitae ipsa. Qui occaecati quam error minima cum sunt adipisci. Placeat consequatur omnis quisquam quia aut praesentium esse. Rem ut sunt maxime qui est facilis fuga. Porro veritatis aperiam qui consequuntur minus. Fugit quas quas praesentium aut ratione modi. Distinctio animi id nulla veniam. Modi perferendis non est mollitia nam est. Voluptatem voluptatem amet et doloribus sunt doloribus. Et iusto eum eligendi quo ea non suscipit. Ipsum ut labore rem. Non earum voluptas cumque dignissimos. Sed distinctio magni doloremque voluptas est. Eum quod laboriosam est dignissimos consectetur. Hic dignissimos optio eum exercitationem voluptas exercitationem. Beatae fugiat assumenda qui debitis. Culpa voluptatem qui sed sunt maxime quam accusamus. Saepe iste expedita dolorem sit nulla. Repellat est excepturi omnis debitis. Aut aut molestiae itaque nulla consequatur quasi amet."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"lang":"de","title":"Omnis delectus omnis odit aut totam.","subtitle":"Praesentium doloribus aut.","description":"Et occaecati ut ea aut voluptates. Omnis tempora sit est esse harum. Veniam molestias architecto vero voluptatem quo distinctio. Velit autem quas sit blanditiis. Quia id voluptas magnam rerum a. Ab minima ipsa reprehenderit. Quos cum beatae qui. Enim explicabo corporis cumque omnis accusamus eveniet ea blanditiis. Dolor dolor qui quia. Molestiae reiciendis delectus pariatur aliquid tempora architecto. Assumenda repellendus ex quo qui animi. Repellat sit voluptates exercitationem rerum odio ut ab consectetur. Similique eos sint quia unde. Velit harum ad eveniet culpa a. Aut libero voluptatem nihil rerum recusandae fuga quia harum. Beatae earum ullam ut et velit ad. Cupiditate sapiente unde quos velit facilis debitis. Illo voluptatem accusantium quo saepe qui tempora voluptatem. Nesciunt dignissimos inventore ut et non officiis tempora. Non voluptatem aperiam eligendi pariatur."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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\/verify\/{id}":{"post":{"summary":"Verify listing markets","description":"Verifies the listing markets.","tags":["Listing"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":{"affectedRows":3}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 that need to be verified. This can also be passed as an array.","format":"integer","in":"path"}]}},"\/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"},"examples":{"application\/json":{"properties":[],"prices":[],"dates":[],"referrerId":104,"listingId":4,"variationId":2,"credentialsId":9}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"An array with child instances to be loaded. One of 'listing', 'texts', 'properties', 'itemSpecifics', 'prices', 'dates', 'infos'.","format":"","in":"query","items":{"type":"string"}}]},"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"},"examples":{"application\/json":{"properties":[],"prices":[],"dates":[],"referrerId":104,"listingId":3,"variationId":6,"credentialsId":8}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"number","required":true,"description":"The referrer ID.","format":"number","in":"query"},{"in":"body","name":"\/rest\/listings\/markets\/{id}","schema":{"type":"object","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"},"examples":{"application\/json":{"listing":{"typeId":2,"stockDependenceTypeId":1,"properties":[{"typeId":10,"value":"Y"},{"typeId":11,"value":1},{"typeId":12,"value":"ean"}]},"listingMarket":{"directoryId":8,"enabled":true,"properties":[{"typeId":100,"value":2},{"typeId":102,"value":124631},{"typeId":103,"value":61960}]},"marketOptions":[{"referrerId":2.08,"duration":3,"subtitle":"New Subtitle","resetItemSpecificsList":true,"properties":[{"typeId":100,"value":3},{"typeId":112,"value":"YES"}]},{"referrerId":101,"duration":3,"subtitle":"New Subtitle","properties":[{"typeId":100,"value":3},{"typeId":112,"value":"YES"}]}],"name":"eligendi"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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"}},"examples":{"application\/json":{"1":"Option template eBay","2":"Option template Hood","3":"Option template Ricardo","4":"Option template all"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"listing":{"typeId":2,"stockDependenceTypeId":1,"properties":[{"typeId":10,"value":"Y"},{"typeId":11,"value":1},{"typeId":12,"value":"ean"}]},"listingMarket":{"directoryId":8,"enabled":true,"properties":[{"typeId":100,"value":2},{"typeId":102,"value":124631},{"typeId":103,"value":61960}]},"marketOptions":[{"referrerId":2.08,"duration":3,"subtitle":"New Subtitle","resetItemSpecificsList":true,"properties":[{"typeId":100,"value":3},{"typeId":112,"value":"YES"}]},{"referrerId":101,"duration":3,"subtitle":"New Subtitle","properties":[{"typeId":100,"value":3},{"typeId":112,"value":"YES"}]}],"name":"voluptatem"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"listing":{"typeId":2,"stockDependenceTypeId":1,"properties":[{"typeId":10,"value":"Y"},{"typeId":11,"value":1},{"typeId":12,"value":"ean"}]},"listingMarket":{"directoryId":8,"enabled":true,"properties":[{"typeId":100,"value":2},{"typeId":102,"value":124631},{"typeId":103,"value":61960}]},"marketOptions":[{"referrerId":2.08,"duration":3,"subtitle":"New Subtitle","resetItemSpecificsList":true,"properties":[{"typeId":100,"value":3},{"typeId":112,"value":"YES"}]},{"referrerId":101,"duration":3,"subtitle":"New Subtitle","properties":[{"typeId":100,"value":3},{"typeId":112,"value":"YES"}]}],"name":"corporis"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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":{"$ref":"#\/definitions\/PaginatedResult"},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"name":"tempore","credentialsId":4,"referrerId":2.08,"createdBy":"customer","isDefault":false,"extendedData":[]},{"name":"voluptates","credentialsId":3,"referrerId":2.08,"createdBy":"customer","isDefault":false,"extendedData":[]}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"number","required":false,"description":"Filter that restricts the search result to listing shipping profiles with given referrer ID(s).","format":"number","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"},"examples":{"application\/json":{"name":"ea","credentialsId":1,"referrerId":2.08,"createdBy":"customer","isDefault":false,"extendedData":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"An array with child instances to be loaded.","format":"","in":"query","items":{"type":"string"}}]}},"\/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":{"$ref":"#\/definitions\/PaginatedResult"},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"id":1,"position":6,"isErasable":false},{"id":5,"position":2,"isErasable":false}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"An array with child instances to be loaded. Available values: 'names'.","format":"","in":"query","items":{"type":"string"}}]}},"\/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"},"examples":{"application\/json":{"id":6,"position":4,"isErasable":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"An array with child instances to be loaded. Available values: 'names'.","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/listings\/types":{"get":{"summary":"List listing types","description":"Lists all listing types.","tags":["Listing"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PaginatedResult"},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"position":7,"isErasable":true},{"position":8,"isErasable":true}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"position":1,"isErasable":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"An array with child instances to be loaded. Available values: 'names'.","format":"","in":"query","items":{"type":"string"}},{"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"},"examples":{"application\/json":{"properties":[{"listingId":null,"typeId":10,"value":"N"},{"listingId":null,"typeId":11,"value":"1"},{"listingId":null,"typeId":12,"value":"none"}],"itemId":1,"unitCombinationId":1,"typeId":3,"stockDependenceTypeId":3}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"An array with child instances to be loaded. One of 'stockDependenceType', 'type', 'markets', 'properties'.","format":"","in":"query","items":{"type":"string"}}]},"put":{"summary":"Update a listing","description":"Updates a listing by given ID.","tags":["Listing"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Listing"},"examples":{"application\/json":{"properties":[{"listingId":null,"typeId":10,"value":"N"},{"listingId":null,"typeId":11,"value":"1"},{"listingId":null,"typeId":12,"value":"none"}],"itemId":0,"unitCombinationId":1,"typeId":2,"stockDependenceTypeId":3}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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 by backend user","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","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 access token","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 user","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\/integration_keys":{"get":{"summary":"Get integration keys","description":"Get the log integration keys.","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 reference types","description":"Get all registered reference types.","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":"Shows a configuration.","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":"Saves a configuration","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\/mail_templates\/email_service\/accounts":{"get":{"summary":"List all email accounts that can be used to send emails (e.g. Webstore or Messenger inboxes)","description":"List all email accounts that can be used to send emails (e.g. Webstore or Messenger inboxes)","tags":["MailTemplates"],"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":"accountType","type":"string","required":true,"description":"Values: webstore OR messenger_inbox.","format":"string","in":"query"}]}},"\/rest\/mail_templates\/email_service\/addToFavourites\/{templateId}":{"post":{"summary":"Add template to favourites for current user","description":"Add template to favourites for current user","tags":["MailTemplates"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"templateId","type":"integer","required":true,"description":"Template id that will be a favourite","format":"integer","in":"path"}]}},"\/rest\/mail_templates\/email_service\/getRecipient":{"get":{"summary":"Get the email of a contact or order based on the receiver type","description":"Get the email of a contact or order based on the receiver type","tags":["MailTemplates"],"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\/mail_templates\/email_service\/history":{"get":{"summary":"List all sent email for a specific entity (e.g order, contact, etc.)","description":"List all sent email for a specific entity (e.g order, contact, etc.)","tags":["MailTemplates"],"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":"type","type":"string","required":true,"description":"History type: of order or contact","format":"string","in":"query"},{"name":"id","type":"integer","required":true,"description":"Search for a specific template","format":"integer","in":"query"}]}},"\/rest\/mail_templates\/email_service\/loadPreview\/{templateId}":{"get":{"summary":"Generates a render preview of a specific template (including attachments)","description":"Generates a render preview of a specific template (including attachments)","tags":["MailTemplates"],"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":"templateId","type":"integer","required":true,"description":"Template id that will be previewed","format":"integer","in":"path"},{"name":"accountType","type":"string","required":true,"description":"Values: webstore OR messenger_inbox.","format":"string","in":"query"},{"name":"conversationId","type":"string","required":false,"description":"Conversation id","format":"string","in":"query"},{"name":"whisperMode","type":"boolean","required":false,"description":"Whisper mode","format":"boolean","in":"query"},{"name":"categoryId","type":"integer","required":false,"description":"Conversation category id","format":"integer","in":"query"},{"name":"loadAttachments","type":"boolean","required":false,"description":"Load the attachments in the response","format":"boolean","in":"query"},{"name":"inboxId","type":"integer","required":false,"description":"Conversation inbox id","format":"integer","in":"query"},{"name":"contacts","type":"string","required":false,"description":"List of contacts ids separated by comma","format":"string","in":"query"},{"name":"orders","type":"string","required":false,"description":"List of orders ids separated by comma","format":"string","in":"query"},{"name":"emails","type":"string","required":false,"description":"List of emails separated by comma","format":"string","in":"query"},{"name":"lang","type":"string","required":false,"description":"Language of template","format":"string","in":"query"},{"name":"receiver","type":"integer","required":false,"description":"Reveceiver for email: DEFAULT = 0, CONTACT = 1,\n * INVOICE_ADDRESS = 2, DELIVERY_ADDRESS = 3, WAREHOUSE = 4, CONTACT_EMAIL_PRIVATE = 5, CONTACT_EMAIL_WORK = 6,\n * CONTACT_EMAIL_PAYPAL = 7,","format":"integer","in":"query"}]}},"\/rest\/mail_templates\/email_service\/removeFromFavourites\/{templateId}":{"post":{"summary":"Remove template from favourites for current user","description":"Remove template from favourites for current user","tags":["MailTemplates"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"templateId","type":"integer","required":true,"description":"Template id that will be removed from favourite","format":"integer","in":"path"}]}},"\/rest\/mail_templates\/email_service\/sendEmail\/{templateId}":{"post":{"summary":"Renders a template and sends an email to the specified recipients","description":"Renders a template and sends an email to the specified recipients","tags":["MailTemplates"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":{"success":0,"message":"Error 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":"templateId","type":"integer","required":true,"description":"Template id that will be sent","format":"integer","in":"path"},{"name":"conversationId","type":"string","required":false,"description":"Conversation id","format":"string","in":"query"},{"name":"contacts","type":"array","required":false,"description":"List of contacts ids","format":"","in":"query","items":{"type":"integer"}},{"name":"orders","type":"array","required":false,"description":"List of orders ids","format":"","in":"query","items":{"type":"integer"}},{"name":"emails","type":"array","required":false,"description":"List of emails","format":"","in":"query","items":{"type":"string"}},{"name":"lang","type":"string","required":false,"description":"Language of template","format":"string","in":"query"},{"name":"receiver","type":"integer","required":false,"description":"Reveceiver for email: DEFAULT = 0, CONTACT = 1,\n * INVOICE_ADDRESS = 2, DELIVERY_ADDRESS = 3, WAREHOUSE = 4, CONTACT_EMAIL_PRIVATE = 5, CONTACT_EMAIL_WORK = 6,\n * CONTACT_EMAIL_PAYPAL = 7,","format":"integer","in":"query"}]}},"\/rest\/mail_templates\/email_service\/sendPreview":{"post":{"summary":"Sends a direct email to the specified recipients (a preview of a template or any other custom content email)","description":"Sends a direct email to the specified recipients (a preview of a template or any other custom content email)","tags":["MailTemplates"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":{"success":0,"message":"Error 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":"account","type":"array","required":true,"description":"Contains all account details:\n * type = string (webstore\/messenger_inbox)\n * id = int (the id of the webStore or de inbox id)\n * name = string (the name of the webStore or de inbox name)\n * from = array ('name': string - the from name, 'address': string - the from email)\n * ","format":"","in":"query","items":{"type":"string"}},{"name":"to","type":"array","required":true,"description":"Array with emails and names for to receivers,\n * [{'name': string, 'address': string}]","format":"","in":"query","items":{"type":"string"}},{"name":"cc","type":"array","required":false,"description":"Array with emails and names for cc receivers,\n * [{'name': string, 'address': string}]","format":"","in":"query","items":{"type":"string"}},{"name":"bcc","type":"array","required":false,"description":"Array with emails and names for bcc receivers,\n * [{'name': string, 'address': string}]","format":"","in":"query","items":{"type":"string"}},{"name":"subject","type":"string","required":true,"description":"The subject of the email","format":"string","in":"query"},{"name":"body","type":"string","required":true,"description":"The content of the email","format":"string","in":"query"},{"name":"attachments","type":"array","required":false,"description":"Array that contains the multipel attachments details:\n * [\n * {\n * 'name': string (File name),\n * 'body': string (File content),\n * 'size': int (File size in kb),\n * 'contentType': string (File content type)\n * }\n * ]\n * ","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/mail_templates\/email_service\/templatesTree":{"get":{"summary":"List all EmailBuilder templates and folders structured as a nested tree","description":"List all EmailBuilder templates and folders structured as a nested tree","tags":["MailTemplates"],"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":"showFavorites","type":"boolean","required":false,"description":"Show favorites;\n * Favourites response folder ID: -1","format":"boolean","in":"query"},{"name":"showOldTemplates","type":"boolean","required":false,"description":"Show old templates;\n * Old templates response folder ID = -2 ","format":"boolean","in":"query"},{"name":"id","type":"integer","required":false,"description":"Search for a specific template","format":"integer","in":"query"},{"name":"name","type":"string","required":false,"description":"Search for a specific template name","format":"string","in":"query"},{"name":"client","type":"integer","required":false,"description":"Search for a specific client","format":"integer","in":"query"},{"name":"owner","type":"integer","required":false,"description":"Search for a specific owner","format":"integer","in":"query"},{"name":"lang","type":"integer","required":false,"description":"Search for a lang (iso code)","format":"integer","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"Sort by id\/name\/createdAt","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"Sort order asc\/desc","format":"string","in":"query"}]}},"\/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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"environment":"production","status":"active","data":{"username":"miller.marquise"},"market":"possimus"},{"environment":"sandbox","status":"active","data":{"username":"rokeefe"},"market":"eum"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"environment":"sandbox","status":"active","data":{"username":"kulas.camilla"},"market":"eum"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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\/all":{"get":{"summary":"List all credentials","description":"Lists all credentials - no pagination - usual filters: market and data['authType']","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."}}}},"\/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"},"examples":{"application\/json":{"environment":"production","status":"inactive","data":{"username":"lura.bartoletti"},"market":"sed"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"environment":"production","status":"inactive","data":{"username":"heaven10"},"market":"et"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"id":9823,"name":"sunt","isLeaf":true,"parentId":123},{"id":3323,"name":"sapiente","isLeaf":true,"parentId":123}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"id":6088,"name":"ut","isLeaf":true,"parentId":123}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":{"post":{"summary":"Create fulfillment policy","description":"Create a fulfillment policy.","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"}]}},"\/rest\/markets\/ebay\/fulfillment_policies\/{id}":{"delete":{"summary":"Delete fulfillment policy","description":"Delete fulfillment policy by given ID.","tags":["Market"],"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":"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"}]},"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"}]},"post":{"summary":"Update fulfillment policy","description":"Update a fulfillment policy.","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":"number","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"}},"examples":{"application\/json":[{"marketId":1015,"name":"blanditiis","categoryId":311044},{"marketId":1008,"name":"ea","categoryId":655194}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"marketId":1020,"name":"eum","categoryId":585298}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"marketId":1011,"name":"quia","categoryId":985086},{"marketId":1000,"name":"dolorum","categoryId":792897}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"An array with child instances to be loaded. Available values: 'items', 'items.properties'.","format":"","in":"query","items":{"type":"string"}}]}},"\/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"},"examples":{"application\/json":{"marketId":1007,"name":"cum","categoryId":110506}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"marketId":1012,"name":"quis","categoryId":448790}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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":{"post":{"summary":"Create payment policy","description":"Create a payment policy.","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"}]}},"\/rest\/markets\/ebay\/payment_policies\/{id}":{"delete":{"summary":"Delete payment policy","description":"Delete payment policy by given ID.","tags":["Market"],"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":"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"}]},"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"}]},"post":{"summary":"Update payment policy","description":"Update 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":{"post":{"summary":"Create return policy","description":"Create a return policy.","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"}]}},"\/rest\/markets\/ebay\/return_policies\/{id}":{"delete":{"summary":"Delete payment policy","description":"Delete payment policy by given ID.","tags":["Market"],"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":"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"}]},"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"}]},"post":{"summary":"Update return policy","description":"Update 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"}},"examples":{"application\/json":{"1":{"id":1,"name":"Level 1 category","order":0,"children":{"12":{"id":12,"parentId":1,"name":"Level 2 category","order":0}}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/ebay\/transactions":{"get":{"summary":"List transactions","description":"Lists transaction by filter options.","tags":["Market"],"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":"Filter that restricts the search result to transactions with specific ID. Use -1 for open orders","format":"integer","in":"query"},{"name":"externalOrderId","type":"integer","required":false,"description":"Filter that restricts the search result to transactions with specific external order ID.","format":"integer","in":"query"},{"name":"transactionId","type":"integer","required":false,"description":"Filter that restricts the search result to transactions with specific transaction ID.","format":"integer","in":"query"},{"name":"credentialsId","type":"integer","required":false,"description":"Filter that restricts the search result to transactions with specific credentials ID.","format":"integer","in":"query"},{"name":"buyerUserId","type":"string","required":false,"description":"Filter that restricts the search result to transactions with specific buyer user ID.","format":"string","in":"query"},{"name":"createdAt","type":"string","required":false,"description":"Filter that restricts the search result to transactions with specific creation date.","format":"string","in":"query"},{"name":"endTime","type":"string","required":false,"description":"Filter that restricts the search result to transactions with end time date.","format":"string","in":"query"},{"name":"importStatus","type":"string","required":false,"description":"Filter that restricts the search result to transactions with specific import status. Possible values are: NEW, IN_PROGRESS, DONE.","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"}]}},"\/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":"number","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"}},"examples":{"application\/json":[{"marketplaceId":"consequatur","type":"property","settings":{"tempora":"corrupti","rem":"a","id":"esse","ipsam":"deleniti"}},{"marketplaceId":"fugit","type":"property","settings":{"omnis":"et","qui":"ut","velit":"aut","voluptatibus":"consectetur"}}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"marketplaceId":"quidem","type":"category","settings":{"voluptas":"rerum","tenetur":"eveniet","ab":"blanditiis","et":"animi"}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"}},"examples":{"application\/json":[{"marketplaceId":"dolorum","type":"shipping","settings":{"sunt":"sapiente","consequuntur":"sed","dolore":"maiores"}},{"marketplaceId":"soluta","type":"property","settings":{"sunt":"sed","est":"dicta","provident":"qui","non":"optio"}}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"}},"examples":{"application\/json":[{"marketplaceId":"tempore","type":"attribute","settings":{"sunt":"non","inventore":"quo","amet":"provident","minus":"quia"}},{"marketplaceId":"eius","type":"attribute","settings":{"harum":"aut","distinctio":"iusto","placeat":"aut","ut":"eum"}}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"marketplaceId":"voluptatem","type":"property","settings":{"autem":"sunt","aliquam":"sunt","modi":"deleniti","sit":"molestiae"}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"marketplaceId":"eaque","type":"attribute","settings":{"et":"illo","omnis":"dolores","ratione":"at"}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"marketplaceId":"neque","type":"category","settings":{"ut":"praesentium","accusamus":"fuga","dolor":"totam","libero":"minima"}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"uuid":"fa84a704-a46c-3875-89dc-70ead4e661c8","plentyIdHash":"dhhp8kyd40qq","linkedTo":[{"type":"contact","value":26615}],"tags":[58,420],"from":{"type":"email","value":"chelsea.nitzsche@hotmail.com","name":"Francisco Larson"},"title":"Ms.","preview":"PROVES his guilt,' said the Dormouse followed him: the March Hare was said to the Gryphon. 'Well, I ","message":"PROVES his guilt,' said the Dormouse followed him: the March Hare was said to the Gryphon. 'Well, I hardly know--No more, thank ye; I'm better now--but I'm a hatter.' Here the other was sitting on the trumpet, and called out 'The Queen! The Queen!' and.","attachedFilesCount":34,"createdAt":"2004-10-05T19:49:42+02:00","updatedAt":"1980-04-12T04:48:54+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","properties":{"message":{"type":"string","description":"The content of the message"},"whispered":{"type":"boolean","description":"Whether the message is whispered\n(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 text\/plain, text\/csv, text\/xml, image\/png, image\/jpg, image\/jpeg, image\/gif, image\/bmp, image\/heic, image\/tiff, image\/x-png, application\/pdf, application\/zip, application\/x-zip-compressed, application\/json, application\/octet-stream, application\/xml, application\/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application\/vnd.ms-excel, application\/msword, application\/vnd.openxmlformats-officedocument.wordprocessingml.document, application\/vnd.ms-powerpoint, application\/vnd.openxmlformats-officedocument.presentationml.presentation"},"categoryId":{"type":"integer","description":"The categoryID of the message\/conversation optional"},"doneAt":{"type":"string","description":"The date the messages was set to done optional"}}}}]}},"\/rest\/messages\/attachments\/all":{"post":{"summary":"Get all attachments by UUID","description":"Gets all attachments as ZIP file. The UUID of the message must be specified.","tags":["Messenger"],"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":"uuid5","type":"string","required":true,"description":"The UUID of the message","format":"string","in":"query"}]}},"\/rest\/messages\/forArchivedConversation":{"get":{"summary":"List archived message stream of a certain conversation","description":"Lists the stream of archived messages of a certain conversation.","tags":["Messenger"],"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 Message","items":{"$ref":"#\/definitions\/Message"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"uuid":"64ab8a77-7ea2-393e-add4-6a87e0e27922","plentyIdHash":"dhhp8kyd40qq","linkedTo":[{"type":"order","value":934371}],"tags":[28,588],"from":{"type":"email","value":"kenya81@hotmail.com","name":"Lilla Spencer"},"title":"Prof.","preview":"I've got to do,' said Alice very politely; but she stopped hastily, for the rest of the sea.' 'I cou","message":"I've got to do,' said Alice very politely; but she stopped hastily, for the rest of the sea.' 'I couldn't afford to learn it.' said the last time she went on again: 'Twenty-four hours, I THINK; or is it I can't take LESS,' said the Mock Turtle said.","attachedFilesCount":22,"createdAt":"1984-10-26T08:31:25+01:00","updatedAt":"1980-05-12T13:55:24+02:00"},{"uuid":"5cdabfba-b015-3fdb-a607-e5e569b95779","plentyIdHash":"dhhp8kyd40qq","linkedTo":[{"type":"contact","value":47055}],"tags":[31,126],"from":{"type":"contact","value":983565},"title":"Dr.","preview":"Hatter were having tea at it: a Dormouse was sitting on a three-legged stool in the last words out l","message":"Hatter were having tea at it: a Dormouse was sitting on a three-legged stool in the last words out loud, and the second time round, she came upon a heap of sticks and dry leaves, and the White Rabbit, who was talking. Alice could hear the name again!'.","attachedFilesCount":6,"createdAt":"1978-11-25T09:05:12+01:00","updatedAt":"1976-04-10T22:13:49+01:00"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"conversationId","type":"string","required":true,"description":"The UUID5 of the conversation.","format":"string","in":"query"}]}},"\/rest\/messages\/forConversation":{"get":{"summary":"List of messages for a single conversation","description":"List of messages for a single conversation","tags":["Messenger"],"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 Message","items":{"$ref":"#\/definitions\/Message"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"uuid":"1a814feb-597a-3c5e-8c5d-a31d5f5074d3","plentyIdHash":"dhhp8kyd40qq","linkedTo":[{"type":"order","value":215618}],"tags":[68,630],"from":{"type":"contact","value":227486},"title":"Mock Turtle interrupted, 'if you don't know of any","preview":"Mock Turtle interrupted, 'if you don't know of any use, now,' thought poor Alice, 'to pretend to be ","message":"Mock Turtle interrupted, 'if you don't know of any use, now,' thought poor Alice, 'to pretend to be sure! However, everything is queer to-day.' Just then her head down to nine inches high. CHAPTER VI. Pig and Pepper For a minute or two to think to.","attachedFilesCount":10,"createdAt":"2023-01-15T19:42:29+01:00","updatedAt":"1993-07-11T22:42:57+02:00"},{"uuid":"33fc45a8-6d43-3b1a-af5a-2c1141fb8c6f","plentyIdHash":"dhhp8kyd40qq","linkedTo":[{"type":"contact","value":71889}],"tags":[29,596],"from":{"type":"email","value":"tdickinson@yahoo.com","name":"Clyde Corkery MD"},"title":"Dr.","preview":"Mouse, sharply and very soon came to the shore, and then said, 'It was the first to speak. 'What siz","message":"Mouse, sharply and very soon came to the shore, and then said, 'It was the first to speak. 'What size do you want to be?' it asked. 'Oh, I'm not myself, you see.' 'I don't know what to beautify is, I suppose?' 'Yes,' said Alice in a hurried nervous.","attachedFilesCount":0,"createdAt":"1983-01-31T15:18:06+01:00","updatedAt":"1977-12-26T14:31:34+01:00"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"conversationId","type":"string","required":true,"description":"The UUID5 of the conversation.","format":"string","in":"query"}]}},"\/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\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"uuid":"92661675-47c4-3527-811d-325edae10a4e","plentyIdHash":"dhhp8kyd40qq","linkedTo":[{"type":"message","value":"1fd903d9-2410-3e10-894c-29ed0a277ba3"}],"tags":[3,955],"from":{"type":"email","value":"abdiel.smitham@yahoo.com","name":"Annamae Oberbrunner"},"title":"Dr.","preview":"It doesn't look like it?' he said. 'Fifteenth,' said the Gryphon. 'Then, you know,' said the Hatter,","message":"It doesn't look like it?' he said. 'Fifteenth,' said the Gryphon. 'Then, you know,' said the Hatter, 'when the Queen was close behind us, and he's treading on my tail. See how eagerly the lobsters to the heads of the moment she appeared; but she knew.","attachedFilesCount":3,"createdAt":"1987-03-22T06:58:26+01:00","updatedAt":"1973-01-27T12:07:59+01:00"},{"uuid":"b6b714c8-077c-398a-b369-09096913357a","plentyIdHash":"dhhp8kyd40qq","linkedTo":[{"type":"order","value":822774}],"tags":[37,567],"from":{"type":"contact","value":114294},"title":"Pig!' She said this last word with such a thing as","preview":"Pig!' She said this last word with such a thing as \"I sleep when I get it home?' when it grunted aga","message":"Pig!' She said this last word with such a thing as \"I sleep when I get it home?' when it grunted again, so she went on so long since she had made out the proper way of speaking to it,' she thought, 'it's sure to do so. 'Shall we try another figure of.","attachedFilesCount":7,"createdAt":"1981-05-12T02:41:26+02:00","updatedAt":"1970-01-14T13:24:11+01:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/attachments\/all":{"get":{"summary":"Get all attachments by UUID","description":"Gets all attachments as ZIP file. The UUID of the message must be specified.","tags":["Messenger"],"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":"uuid5","type":"string","required":true,"description":"The UUID of the message","format":"string","in":"path"}]}},"\/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"},"examples":{"application\/json":{"uuid":"c4919fc6-5687-3eaf-be02-4724d994f387","plentyIdHash":"dhhp8kyd40qq","linkedTo":[{"type":"order","value":596015}],"tags":[69,695],"from":{"type":"email","value":"shana80@fahey.com","name":"Mr. Keenan Heathcote I"},"title":"However, the Multiplication Table doesn't signify:","preview":"However, the Multiplication Table doesn't signify: let's try Geography. London is the reason is--' h","message":"However, the Multiplication Table doesn't signify: let's try Geography. London is the reason is--' here the Mock Turtle in a solemn tone, only changing the order of the country is, you know. Which shall sing?' 'Oh, YOU sing,' said the Pigeon. 'I can see.","attachedFilesCount":15,"createdAt":"1993-01-22T19:32:11+01:00","updatedAt":"1990-06-10T06:17:40+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"uuid":"6e520e3e-c7c3-3342-83a4-e1ea4222afd2","plentyIdHash":"dhhp8kyd40qq","linkedTo":[{"type":"contact","value":47907}],"tags":[63,359],"from":{"type":"email","value":"larkin.garnet@mcdermott.com","name":"Eda Johnston"},"title":"Prof.","preview":"Footman went on 'And how many hours a day is very confusing.' 'It isn't,' said the sage, as he came,","message":"Footman went on 'And how many hours a day is very confusing.' 'It isn't,' said the sage, as he came, 'Oh! the Duchess, digging her sharp little chin into Alice's shoulder as she spoke. (The unfortunate little Bill had left off quarrelling with the day.","attachedFilesCount":49,"createdAt":"1999-12-06T06:04:41+01:00","updatedAt":"1992-04-17T02:40:27+02:00"},{"uuid":"8cb98818-614c-3208-898b-8b8ef62e32be","plentyIdHash":"dhhp8kyd40qq","linkedTo":[{"type":"order","value":815818}],"tags":[49,170],"from":{"type":"email","value":"crist.leta@hotmail.com","name":"Prof. Peyton Moore"},"title":"Dr.","preview":"Ann! Mary Ann!' said the White Rabbit read out, at the Gryphon replied very gravely. 'What else have","message":"Ann! Mary Ann!' said the White Rabbit read out, at the Gryphon replied very gravely. 'What else have you got in your knocking,' the Footman remarked, 'till tomorrow--' At this moment Alice felt dreadfully puzzled. The Hatter's remark seemed to follow.","attachedFilesCount":43,"createdAt":"1988-11-01T13:27:24+01:00","updatedAt":"1971-07-10T12:42:57+01:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"uuid":"db52ce72-b583-3794-84a6-cf107e5aa5f9","plentyIdHash":"dhhp8kyd40qq","linkedTo":[{"type":"order","value":363987}],"tags":[40,942],"from":{"type":"contact","value":581699},"title":"I'm a deal faster than it does.' 'Which would NOT ","preview":"I'm a deal faster than it does.' 'Which would NOT be an advantage,' said Alice, swallowing down her ","message":"I'm a deal faster than it does.' 'Which would NOT be an advantage,' said Alice, swallowing down her anger as well say,' added the Dormouse, without considering at all what had become of me?' Luckily for Alice, the little glass box that was sitting on a.","attachedFilesCount":32,"createdAt":"2001-08-06T01:08:05+02:00","updatedAt":"1976-05-17T06:04:17+01:00"},{"uuid":"c81f79f7-28ab-3b3c-913d-083561ea1e56","plentyIdHash":"dhhp8kyd40qq","linkedTo":[{"type":"message","value":"7e97e35b-05ec-3da9-a0f0-810526426357"}],"tags":[93,457],"from":{"type":"email","value":"murphy.phyllis@hotmail.com","name":"Tess Kunze"},"title":"Mr.","preview":"They all returned from him to be afraid of them!' 'And who is Dinah, if I shall have to turn into a ","message":"They all returned from him to be afraid of them!' 'And who is Dinah, if I shall have to turn into a sort of circle, ('the exact shape doesn't matter,' it said,) and then quietly marched off after the candle is like after the rest of it altogether; but.","attachedFilesCount":35,"createdAt":"1987-01-05T20:59:12+01:00","updatedAt":"1978-11-14T19:00:10+01:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":{"$ref":"#\/definitions\/Message"},"examples":{"application\/json":{"uuid":"d4b95529-66c6-3c62-a953-61b638b82f76","plentyIdHash":"dhhp8kyd40qq","linkedTo":[{"type":"contact","value":63437}],"tags":[66,207],"from":{"type":"email","value":"oritchie@macejkovic.com","name":"Eulalia Borer"},"title":"Dr.","preview":"If she should meet the real Mary Ann, and be turned out of that is, but I don't believe you do eithe","message":"If she should meet the real Mary Ann, and be turned out of that is, but I don't believe you do either!' And the executioner ran wildly up and said, 'It was the cat.) 'I hope they'll remember her saucer of milk at tea-time. Dinah my dear! I shall fall.","attachedFilesCount":20,"createdAt":"2014-11-09T12:36:17+01:00","updatedAt":"1975-09-11T20:35:57+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":true,"description":"The tags of the message","format":"","in":"query","items":{"type":"integer"}},{"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"}},"examples":{"application\/json":[{"uuid":"2b76563f-a2d7-38f7-b6d5-d92c178eddf6","plentyIdHash":"dhhp8kyd40qq","linkedTo":[{"type":"order","value":483075}],"tags":[71,102],"from":{"type":"user","value":271,"name":"lharber"},"title":"Mr.","preview":"Alice, thinking it was addressed to the Knave was standing before them, in chains, with a round face","message":"Alice, thinking it was addressed to the Knave was standing before them, in chains, with a round face, and large eyes full of soup. 'There's certainly too much pepper in that soup!' Alice said with a yelp of delight, and rushed at the top of her voice.","attachedFilesCount":35,"createdAt":"2006-04-10T04:45:12+02:00","updatedAt":"1979-08-23T06:10:14+01:00"},{"uuid":"22f6a8d8-405b-3776-bafa-76ddea79f006","plentyIdHash":"dhhp8kyd40qq","linkedTo":[{"type":"order","value":563956}],"tags":[0,101],"from":{"type":"user","value":477,"name":"kris.tony"},"title":"IN the well,' Alice said with some difficulty, as ","preview":"IN the well,' Alice said with some difficulty, as it could go, and broke off a head unless there was","message":"IN the well,' Alice said with some difficulty, as it could go, and broke off a head unless there was enough of it at last, and managed to put everything upon Bill! I wouldn't be in Bill's place for a conversation. Alice replied, rather shyly, 'I--I.","attachedFilesCount":40,"createdAt":"2019-04-08T18:41:36+02:00","updatedAt":"1975-05-30T19:07:57+01:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/messenger\/settings":{"get":{"summary":"Retrieves the general settings object","description":"Retrieves the general settings object","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationSettings"},"examples":{"application\/json":{"automaticTrashEmpty":{"enabled":false,"days":30},"automaticArchive":{"enabled":false,"days":180}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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":"Updates the general settings object","description":"Updates the general settings object","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ConversationSettings"},"examples":{"application\/json":{"automaticTrashEmpty":{"enabled":false,"days":30},"automaticArchive":{"enabled":false,"days":180}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/messenger\/settings\/getDefaultWhisperMode":{"get":{"summary":"Retrieves the default value for whisper mode","description":"Retrieves the default value for whisper mode","tags":["Messenger"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/int"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/multi_credit_notes\/{orderId}":{"delete":{"summary":"Delete a multi credit note","description":"Deletes a multi credit note. 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 multi credit note","description":"Updates a multi credit note. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":3,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/multi_orders\/{orderId}":{"delete":{"summary":"Delete a multi sales order","description":"Deletes a multi sales order. 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 multi order","description":"Updates a multi order. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":6,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/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 a newsletter entry. The newsletter subject 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":true,"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","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 newsletter folder. The name 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":"id","type":"integer","required":false,"description":"The ID of the newsletter folder","format":"integer","in":"query"},{"name":"name","type":"string","required":true,"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","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\/search":{"get":{"summary":"","description":"","tags":[""],"responses":{"200":{"description":"OK"}}}},"\/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":"array","required":false,"description":"The IDs of the clients (stores). It is possible to determine which clients (stores) the newsletter folder is visible for. ","format":"","in":"query","items":{"type":"string"}},{"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 recipients from all newsletter folders.","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":"array","required":false,"description":"Filter that restricts the search result to specific columns","format":"","in":"query","items":{"type":"string"}},{"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":"array","required":false,"description":"Load additional relations for a Recipient. CURRENTLY NOT AVAILABLE","format":"","in":"query","items":{"type":"string"}},{"name":"recipientId","type":"integer","required":true,"description":"The ID of the recipient","format":"integer","in":"query"}]}},"\/rest\/newsletters\/orders\/import":{"post":{"summary":"","description":"","tags":[""],"responses":{"200":{"description":"OK"}}}},"\/rest\/newsletters\/orders\/search":{"get":{"summary":"","description":"","tags":[""],"responses":{"200":{"description":"OK"}}}},"\/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":"array","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":"","in":"query","items":{"type":"string"}},{"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","properties":{"email":{"type":"string","description":"The email address of the recipient"}}}}]}},"\/rest\/newsletters\/recipients\/batch":{"delete":{"summary":"","description":"","tags":[""],"responses":{"200":{"description":"OK"}}}},"\/rest\/newsletters\/recipients\/batchUpdate":{"put":{"summary":"","description":"","tags":[""],"responses":{"200":{"description":"OK"}}}},"\/rest\/newsletters\/recipients\/move":{"put":{"summary":"","description":"","tags":[""],"responses":{"200":{"description":"OK"}}}},"\/rest\/newsletters\/recipients\/moveById":{"put":{"summary":"","description":"","tags":[""],"responses":{"200":{"description":"OK"}}}},"\/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":"array","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":"","in":"query","items":{"type":"string"}},{"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","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\/offers":{"post":{"summary":"Create an offer","description":"Creates an offer.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":6,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/offers\/items\/{orderItemId}\/assign_variation":{"post":{"summary":"Change an order item of type \"unassigned variation\" to \"variation\".","description":"Change an order item of type \"unassigned variation\" to \"variation\". The ID of the order item and variation ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":6,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/offers\/items\/{orderItemId}\/unassign_variation":{"post":{"summary":"Change an order item of type \"variation\" to \"unassigned variation\".","description":"Change an order item of type \"variation\" to \"unassigned variation\". The ID of the order item must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":3,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/offers\/preview":{"post":{"summary":"Get an offer create preview.","description":"Returns an offer preview for the given order data without creating an offer.","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\/offers\/{orderId}":{"delete":{"summary":"Delete an offer","description":"Deletes an offer. 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 an offer","description":"Updates an offer. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":4,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/offers\/{orderId}\/preview":{"put":{"summary":"Get an offer update preview","description":"Returns an offer preview for the given order data without updating an offer. The order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/offers\/{orderId}\/restore":{"post":{"summary":"Restore an offer","description":"Restores a deleted offer. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":5,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":{"get":{"summary":"Search order","description":"<b>DEPRECATED: Use the following route: GET \/rest\/orders\/search<\/b>\nSearches 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"statusName":"","plentyId":65411,"typeId":2,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]},{"statusName":"","plentyId":65411,"typeId":3,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"contactData","type":"string","required":false,"description":"Filter that restricts the search result to orders with a specific contact data.","format":"string","in":"query"},{"name":"referrerId","type":"number","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":"number","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":"array","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":"","in":"query","items":{"type":"string"}},{"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":"packageNumber","type":"string","required":false,"description":"Filter that restricts the search result to orders including a specific package number. The number of the package must be specified.","format":"string","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. This filter can be used alone or can be combined with the UpdatedAtTo 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":"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":"number","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":"number","in":"query"},{"name":"statusTo","type":"number","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":"number","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 <i>multi_invoice<\/i>, <i>multi_credit_note<\/i>, <i>success_confirmation<\/i>, <i>return_note<\/i>, <i>pickup_delivery<\/i>, <i>repair_bill<\/i>, <i>dunning_letter<\/i>, <i>offer<\/i>, <i>order_confirmation<\/i>, <i>credit_note<\/i>, <i>correction_document<\/i>, <i>delivery_note<\/i>, <i>invoice<\/i>, <i>invoice_external<\/i>, <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":"externalItemId","type":"string","required":false,"description":"Filter that restricts the search result to orders that have order items with the given external item ID.","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 orders to be displayed per page. The default number of orders per page is 50.","format":"integer","in":"query"},{"name":"with","type":"array","required":false,"description":"Load additional relations for an order. Currently possible are:\n <ul>\n <li>'addresses' = The address objects that are associated with the order.<\/li>\n <li>'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 <li>'comments' = The order comments.<\/li>\n <li>'location' = The accounting location of the order.<\/li>\n <li>'payments' = The payments that are associated with the order.<\/li>\n <li>'documents' = The documents that are associated with the order.<\/li>\n <li>'contactSender' = The associated contact for the contact-sender relation.<\/li>\n <li>'contactReceiver' = The associated contact for the contact-receiver relation.<\/li>\n <li>'warehouseSender' = The associated warehouse for the warehouse-sender relation.<\/li>\n <li>'warehouseReceiver' = The associated warehouse for the warehouse-receiver relation.<\/li>\n <li>'orderItems.variation' = The variation that is associated with the order item.<\/li>\n <li>'orderItems.variation.propertiesV2' = The properties belonging to the variation.<\/li>\n <li>'orderItems.giftCardCodes' = The gift card codes that are associated with the order item.<\/li>\n <li>'orderItems.transactions' = The transactions that are associated with the order item.<\/li>\n <li>'orderItems.serialNumbers' = The serial numbers that are associated with the order item.<\/li>\n <li>'orderItems.variationBarcodes' = The barcodes that are associated with variation of the order item.<\/li>\n <li>'orderItems.comments' = The comments that are associated with the order item.<\/li>\n <li>'originOrderReferences' = The references to other orders, e.g. returns or credit notes, associated with this order.<\/li>\n <li>'shippingPackages' = The shipping packages that are associated with the order.<\/li>\n <li>'shippingPackages.items' = The orderPackageItems associated with the package.<\/li>\n <li>'shippingInformation' = The shipping information for the order.<\/li>\n <li>'paymentTerms' = The payment terms that are associated with the order.<\/li>\n <li><b>deprecated<\/b> 'orderItems.warehouseLocations' = The warehouse locations that are associated with the order item.<\/li>\n <\/ul>\n Example: <code>?with[]=addresses&with[]=orderItems.variation<\/code>","format":"","in":"query","items":{"type":"string"}},{"name":"sortBy","type":"string","required":false,"description":"Sort the result. Possible values are\n <ul>\n <li>'id': Sort by order ID (default)<\/li>\n <li>'statusId': Sort by order status ID<\/li>\n <li>'createdAt': Sort by order creation date<\/li>\n <li>'orderDocument': Sort by order document number<\/li>\n <\/ul>\n ","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"Sorting behaviour. Possible values are\n <ul>\n <li>'asc': Sort by ascending order (default)<\/li>\n <li>'desc': Sort by descending order<\/li>\n <\/ul>\n ","format":"string","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"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":4,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"One or multiple coupon code to be redeemed with order creation","format":"","in":"query","items":{"type":"string"}},{"in":"body","name":"\/rest\/orders","schema":{"type":"object","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 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"},"examples":{"application\/json":{"id":7,"orderId":3,"typeId":4,"addressId":4}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/batch":{"get":{"summary":"Get orders","description":"Gets orders. The IDs of the orders 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":"orderIds","type":"array","required":true,"description":"The IDs of the orders.","format":"","in":"query","items":{"type":"integer"}},{"name":"with","type":"array","required":false,"description":"Load additional relations for an order. The following relations are available:\n * <ul>\n <li>'addresses' = The address objects linked to the order.<\/li>\n <li>'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 <li>'comments' = The order comments.<\/li>\n <li>'location' = The accounting location linked to the order.<\/li>\n <li>'payments' = The payments linked to the order.<\/li>\n <li>'documents' = The documents linked to the order.<\/li>\n <li>'contactSender' = The contact belonging the contact-sender relation.<\/li>\n <li>'contactReceiver' = The contact belonging to the contact-receiver relation.<\/li>\n <li>'warehouseSender' = The warehouse belonging to the warehouse-sender relation.<\/li>\n <li>'warehouseReceiver' = The warehouse belonging to the warehouse-receiver relation.<\/li>\n <li>'orderItems.variation' = The variation data belonging to the order item.<\/li>\n <li>'orderItems.variation.propertiesV2' = The properties belonging to the variation.<\/li>\n <li>'orderItems.giftCardCodes' = The gift card codes belonging to the order item.<\/li>\n <li>'orderItems.transactions' = The transactions belonging to the order item.<\/li>\n <li>'orderItems.serialNumbers' = The serial numbers belonging to the order item.<\/li>\n <li>'orderItems.variationBarcodes' = The barcodes belonging to the order item.<\/li>\n <li>'orderItems.comments' = The comments belonging to the order item.<\/li>\n <li>'shippingPackages' = The shipping packages that are associated with the order.<\/li>\n <li>'paymentTerms' = The payment terms that are associated with the order.<\/li>\n <li><b>deprecated<\/b> 'orderItems.warehouseLocations' = The warehouse locations linked to the order item.<\/li>\n <\/ul>\n Example: <code>?with[]=addresses&with[]=orderItems.variation<\/code>","format":"","in":"query","items":{"type":"string"}},{"name":"addOrderItems","type":"boolean","required":false,"description":"Add the order items to the result. Default = true.","format":"boolean","in":"query"}]}},"\/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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"statusName":"","plentyId":65411,"typeId":1,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]},{"statusName":"","plentyId":65411,"typeId":7,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"Load additional relations for an order. The following relations are available:\n * <ul>\n <li>'addresses' = The address objects linked to the order.<\/li>\n <li>'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 <li>'comments' = The order comments.<\/li>\n <li>'location' = The accounting location linked to the order.<\/li>\n <li>'payments' = The payments linked to the order.<\/li>\n <li>'documents' = The documents linked to the order.<\/li>\n <li>'contactSender' = The contact belonging the contact-sender relation.<\/li>\n <li>'contactReceiver' = The contact belonging to the contact-receiver relation.<\/li>\n <li>'warehouseSender' = The warehouse belonging to the warehouse-sender relation.<\/li>\n <li>'warehouseReceiver' = The warehouse belonging to the warehouse-receiver relation.<\/li>\n <li>'orderItems.variation' = The variation data belonging to the order item.<\/li>\n <li>'orderItems.variation.propertiesV2' = The properties belonging to the variation.<\/li>\n <li>'orderItems.giftCardCodes' = The gift card codes belonging to the order item.<\/li>\n <li>'orderItems.transactions' = The transactions belonging to the order item.<\/li>\n <li>'orderItems.serialNumbers' = The serial numbers belonging to the order item.<\/li>\n <li>'orderItems.variationBarcodes' = The barcodes belonging to the order item.<\/li>\n <li>'orderItems.comments' = The comments belonging to the order item.<\/li>\n <li>'shippingPackages' = The shipping packages that are associated with the order.<\/li>\n <li>'paymentTerms' = The payment terms that are associated with the order.<\/li>\n <li><b>deprecated<\/b> 'orderItems.warehouseLocations' = The warehouse locations linked to the order item.<\/li>\n <\/ul>\n Example: <code>?with[]=addresses&with[]=orderItems.variation<\/code>","format":"","in":"query","items":{"type":"string"}}]}},"\/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"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":8,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":{"get":{"summary":"Get list of campaigns","description":"Get the list of campaigns paginated","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 CouponCampaign","items":{"$ref":"#\/definitions\/CouponCampaign"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"name":"dolorum","variable":0,"isPermittedForExternalReferrers":false,"includeShipping":true,"unusedCodesCount":0,"usedCodesCount":2,"endsAt":"1974-08-06T01:22:52+01:00","startsAt":"1972-06-12T20:33:29+01:00","minOrderValue":2288402.07,"codeDurationWeeks":7204,"codeAssignment":"only_use_existing","codeLength":"large","usage":"single_order","redeemType":"single_redeem_per_user","concept":"multi_code","type":"plenty","discountType":"item","couponType":"sales","campaignType":"coupon","description":"Doloremque sed tempore a aut similique at asperiores. Officia voluptatibus corporis modi quia a ut. Vel assumenda fuga quibusdam eius non. Ut incidunt id adipisci et veniam.","value":0.76},{"name":"distinctio","variable":4,"isPermittedForExternalReferrers":true,"includeShipping":false,"unusedCodesCount":5,"usedCodesCount":0,"endsAt":"1986-10-23T20:34:43+01:00","startsAt":"1973-11-21T12:55:15+01:00","minOrderValue":2.16,"codeDurationWeeks":7430153,"codeAssignment":"use_existing","codeLength":"large","usage":"subscription","redeemType":"multi_redeem_per_user","concept":"multi_code","type":"plenty","discountType":"fixed","couponType":"promotion","campaignType":"coupon","description":"Nesciunt eveniet qui vel mollitia. Et sed earum sed ullam sit omnis. Magnam et eos vitae sed ducimus recusandae quia.","value":815234.31}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/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"},"examples":{"application\/json":{"code":"g4d1s0c0","campaignId":9,"disabled":0,"consumed":0,"usedCount":410,"usedAmount":0.39,"generatedAt":"1982-05-25T03:37:59+02:00","lastUsedAt":"1999-05-30T13:25:11+02:00","consumedAt":"2015-05-24T02:54:10+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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.\n * Currently possible are:\n * <ul>\n * <li>'campaign' = The coupon campaign to which this code belongs to.<\/li>\n * <\/ul>\n * Example: <code>?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}":{"get":{"summary":"Get campaign by Id","description":"Get details for specific campaign by id","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/CouponCampaign"},"examples":{"application\/json":{"name":"rerum","variable":9,"isPermittedForExternalReferrers":false,"includeShipping":true,"unusedCodesCount":9,"usedCodesCount":1,"endsAt":"2012-06-06T13:23:03+02:00","startsAt":"1994-10-08T00:21:44+01:00","minOrderValue":7.71,"codeDurationWeeks":8,"codeAssignment":"use_existing","codeLength":"large","usage":"single_and_subscription","redeemType":"redeem_until_value_reached","concept":"multi_code","type":"plenty","discountType":"fixed","couponType":"sales","campaignType":"coupon","description":"Modi dolorum fugiat ipsa voluptatem non nostrum. Velit id dolore aut consequatur aut. Voluptas reiciendis sequi autem est explicabo ut voluptatem inventore.","value":69494962.6}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/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.\nA code can optionally be specified. A random code will be generated if the code is not specified.\nA coupon value can also be optionally specified.\nThe 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"},"examples":{"application\/json":{"code":"u2i8t9k6","campaignId":4,"disabled":1,"consumed":1,"usedCount":458,"usedAmount":4063.07,"generatedAt":"1994-07-08T03:22:28+02:00","lastUsedAt":"1995-01-29T12:15:01+01:00","consumedAt":"1994-08-29T17:23:31+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"validationType":"plenty","items":[{"amount":264.32,"noCoupon":0,"quantity":2,"singlePrice":132.16,"itemId":441,"vatField":0}],"contactId":16,"couponCode":"49PCKI","currency":"EUR","referrer":92.09,"salesDiscount":-22,"salesDiscountNet":-18.487394957983,"itemDiscount":-22,"itemDiscountNet":-18.487394957983,"shippingDiscount":0,"shippingDiscountNet":0,"usedVatFields":[-22],"restCouponAmount":0,"checkedItems":{"441":264.32},"validateParams":{"callFromScheduler":false,"webstoreId":0,"shipToCountry":1,"taxIdNumber":19,"contactClass":2,"contactType":1}},{"validationType":"plenty","items":[{"amount":244.44,"noCoupon":0,"quantity":2,"singlePrice":122.22,"itemId":540,"vatField":0}],"contactId":30,"couponCode":"992DI8","currency":"EUR","referrer":30.36,"salesDiscount":-5,"salesDiscountNet":-4.2016806722689,"itemDiscount":-5,"itemDiscountNet":-4.2016806722689,"shippingDiscount":0,"shippingDiscountNet":0,"usedVatFields":[-5],"restCouponAmount":0,"checkedItems":{"540":244.44},"validateParams":{"callFromScheduler":false,"webstoreId":0,"shipToCountry":1,"taxIdNumber":19,"contactClass":2,"contactType":1}}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":true,"description":"The coupons to validate.","format":"","in":"query","items":{"type":"string"}},{"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","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"code":"sit","contactId":5,"openAmount":691369.42,"redeemCount":713301,"updatedAt":"2025-09-10T10:38:13+02:00","campaignId":21,"externalTransactionId":7},{"code":"non","contactId":9,"openAmount":96458.01,"redeemCount":38079,"updatedAt":"2025-09-10T10:38:13+02:00","campaignId":733,"externalTransactionId":13716374}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"validationType":"plenty","items":[{"amount":325.5,"noCoupon":0,"quantity":5,"singlePrice":65.1,"itemId":208,"vatField":0}],"contactId":93,"couponCode":"AI0VH6","currency":"EUR","referrer":2.16,"salesDiscount":-12,"salesDiscountNet":-10.084033613445,"itemDiscount":-12,"itemDiscountNet":-10.084033613445,"shippingDiscount":0,"shippingDiscountNet":0,"usedVatFields":[-12],"restCouponAmount":0,"checkedItems":{"208":325.5},"validateParams":{"callFromScheduler":false,"webstoreId":0,"shipToCountry":1,"taxIdNumber":19,"contactClass":9,"contactType":1}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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":"List currencies supported in the system.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/Currency"}},"examples":{"application\/json":[{"currency":"EUR","htmlCode":"€","unicodeSign":"\u20ac","isActive":true,"isErasable":false,"exchangeRate":1},{"currency":"EUR","htmlCode":"€","unicodeSign":"\u20ac","isActive":true,"isErasable":false,"exchangeRate":1}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The attributes to be loaded","format":"","in":"query","items":{"type":"string"}},{"name":"with","type":"array","required":false,"description":"The relations to be loaded. Valid relations are 'names' or 'countries'.","format":"","in":"query","items":{"type":"string"}}]}},"\/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"},"examples":{"application\/json":{"currency":"EUR","htmlCode":"€","unicodeSign":"\u20ac","isActive":true,"isErasable":false,"exchangeRate":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The attributes to be loaded","format":"","in":"query","items":{"type":"string"}},{"name":"with","type":"array","required":false,"description":"The relations to be loaded. Valid relations are 'names' or 'countries').","format":"","in":"query","items":{"type":"string"}},{"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":"Route is deprecated. Do not use anymore.","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":"Route is deprecated. Do not use anymore.","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\/live_exchange_rates":{"get":{"summary":"Get the live exchange rates","description":"Gets the live exchange rates for the system currency.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/LiveExchangeRatesResult"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/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"},"examples":{"application\/json":{"currency":"EUR","htmlCode":"€","unicodeSign":"\u20ac","isActive":true,"isErasable":false,"exchangeRate":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The attributes to be loaded","format":"","in":"query","items":{"type":"string"}},{"name":"with","type":"array","required":false,"description":"The relations to be loaded. Valid relations are 'names' or 'countries'","format":"","in":"query","items":{"type":"string"}}]}},"\/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"}},"examples":{"application\/json":[{"name":"Norfolk Island","shippingDestinationId":137,"active":2,"storehouseId":15,"isoCode2":"CC","isoCode3":"CU","lang":"om","isCountryStateMandatory":false,"vatCodes":[]},{"name":"Singapore","shippingDestinationId":113,"active":0,"storehouseId":29,"isoCode2":"GQ","isoCode3":"MM","lang":"jv","isCountryStateMandatory":false,"vatCodes":[]}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The attributes to be loaded","format":"","in":"query","items":{"type":"string"}}]}},"\/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<br><ul>\n<li>1 = Deleted on<\/li>\n<li>2 = Created on<\/li>\n<li>3 = Paid date<\/li>\n<li>4 = Last update<\/li>\n<li>5 = Completed on<\/li>\n<li>6 = Return date<\/li>\n<li>7 = Payment due date<\/li>\n<li>8 = Estimated shipping date<\/li>\n<li>9 = Start date<\/li>\n<li>10 = End date<\/li>\n<li>11 = Possible delivery date<\/li>\n<li>12 = Market transfer date<\/li>\n<li>13 = Subscription cancelled on<\/li>\n<li>14 = Subscription last run<\/li>\n<li>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."}}},"post":{"summary":"Create an order date type.","description":"Creates an order date type.","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."}}}},"\/rest\/orders\/dates\/types\/{typeId}":{"delete":{"summary":"Delete an order date type.","description":"Deletes an order date type. The ID of the date type 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":"typeId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"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<br><ul>\n<li>1 = Deleted on<\/li>\n<li>2 = Created on<\/li>\n<li>3 = Paid date<\/li>\n<li>4 = Last update<\/li>\n<li>5 = Completed on<\/li>\n<li>6 = Return date<\/li>\n<li>7 = Payment due date<\/li>\n<li>8 = Estimated shipping date<\/li>\n<li>9 = Start date<\/li>\n<li>10 = End date<\/li>\n<li>11 = Possible delivery date<\/li>\n<li>12 = Market transfer date<\/li>\n<li>13 = Subscription cancelled on<\/li>\n<li>14 = Subscription last run<\/li>\n<li>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"}]},"put":{"summary":"Update an order date type.","description":"Updates an order date type. The ID of the date type must be specified.","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<br><ul>\n<li>1 = Deleted on<\/li>\n<li>2 = Created on<\/li>\n<li>3 = Paid date<\/li>\n<li>4 = Last update<\/li>\n<li>5 = Completed on<\/li>\n<li>6 = Return date<\/li>\n<li>7 = Payment due date<\/li>\n<li>8 = Estimated shipping date<\/li>\n<li>9 = Start date<\/li>\n<li>10 = End date<\/li>\n<li>11 = Possible delivery date<\/li>\n<li>12 = Market transfer date<\/li>\n<li>13 = Subscription cancelled on<\/li>\n<li>14 = Subscription last run<\/li>\n<li>15 = Subscription next run<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/OrderDateTypeName"}},"examples":{"application\/json":[{"typeId":3247,"lang":"gu","name":"aliquid"},{"typeId":106625585,"lang":"te","name":"incidunt"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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<br><ul>\n<li>1 = Deleted on<\/li>\n<li>2 = Created on<\/li>\n<li>3 = Paid date<\/li>\n<li>4 = Last update<\/li>\n<li>5 = Completed on<\/li>\n<li>6 = Return date<\/li>\n<li>7 = Payment due date<\/li>\n<li>8 = Estimated shipping date<\/li>\n<li>9 = Start date<\/li>\n<li>10 = End date<\/li>\n<li>11 = Possible delivery date<\/li>\n<li>12 = Market transfer date<\/li>\n<li>13 = Subscription cancelled on<\/li>\n<li>14 = Subscription last run<\/li>\n<li>15 = Subscription next run<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderDateTypeName"},"examples":{"application\/json":{"typeId":707099,"lang":"bh","name":"harum"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"Lists all order regardless of type.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"type":"credit_note_external","number":946936,"numberWithPrefix":"omnis","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":10,"source":"hitmeister","displayDate":"1991-08-12T02:39:40+02:00","status":"done"},{"type":"incoming_items_register","number":61140,"numberWithPrefix":"dignissimos","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":9,"source":"klarna","displayDate":"2002-07-29T01:15:33+02:00","status":"done"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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.\n * 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\n * of time. This filter can be used alone or can be combined with the CreatedAtFrom filter. The\n * 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.\n * 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\n * of time. This filter can be used alone or can be combined with the displayDateFrom filter. The\n * 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":"array","required":false,"description":"Load additional relations for a document. Currently possible are:\n <ul>\n <li>'references' = The document reference objects that are associated with the document.<\/li>\n <\/ul>\n Example: <code>?with[]=references<\/code>","format":"","in":"query","items":{"type":"string"}}]}},"\/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"},"examples":{"application\/json":{"orderId":13487,"methodOfPaymentId":8,"parentDocument":{"type":"invoice","number":"RE17002140"},"document":{"type":"reversal_document","number":"ST170000142","date":"2017-07-24 00:00:00"},"contact":{"contactId":29242,"bookAccount":"","billingAddressId":39927,"company":"","firstName":"Max","lastName":"Mustermann","billingCountryISO":"DE","deliveryCountryISO":"DE","VATNumber":"","deliveryAddressId":29710,"hasEntryCertificat":false},"amounts":{"paidAmount":0,"invoiceTotal":299,"totalNet":251.26,"totalVat":47.74,"vat":[{"countryVatId":1,"vatField":0,"vatAmount":47.74,"netAmount":251.26,"grossAmount":299}]},"items":[{"orderItemId":18698,"itemId":42271,"variationId":79079,"quantity":1,"typeId":1,"priceGross":299,"priceNet":251.26,"countryVatId":1,"vatField":0,"vatAmount":47.74}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/as_zip":{"get":{"summary":"Download documents","description":"Downloads all documents as a zip file.\nThe documents must be given as an array of indices. An optional filename for the zip file can also be given","tags":["Document"],"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":"ids","type":"array","required":true,"description":"The document ids to be downloaded","format":"","in":"query","items":{"type":"integer"}},{"name":"filename","type":"string","required":false,"description":"The filename to be used for the zip file","format":"string","in":"query"}]},"post":{"summary":"Download documents","description":"Downloads all documents as a zip file.\nThe documents must be given as an array of indices. An optional filename for the zip file can also be given","tags":["Document"],"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":"ids","type":"array","required":true,"description":"The document ids to be downloaded","format":"","in":"query","items":{"type":"integer"}},{"name":"filename","type":"string","required":false,"description":"The filename to be used for the zip file","format":"string","in":"query"}]}},"\/rest\/orders\/documents\/downloads\/as_zip\/asynchronous":{"get":{"summary":"Download documents asynchronous","description":"Downloads all documents asynchronous as a zip file. The documents must be given as an array of indices.","tags":["Document"],"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":"ids","type":"array","required":true,"description":"The document ids to be downloaded","format":"","in":"query","items":{"type":"integer"}}]}},"\/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.\n * 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\n * of time. This filter can be used alone or can be combined with the CreatedAtFrom filter.\n * 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.\n * 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\n * of time. This filter can be used alone or can be combined with the UpdatedAtFrom filter.\n * 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.\n * 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\n * period of time. This filter can be used alone or can be combined with the displayDateFrom\n * 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,\n * posCouponReceipt, posInvoice, posInvoiceCancellation, cancellation, invoiceExternal, invoice,\n * deliveryNote, creditNote, creditNoteExternal, orderConfirmation, offer, dunningLetter,\n * 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.\n * The maximum number is 6000.","format":"integer","in":"query"}]}},"\/rest\/orders\/documents\/find":{"get":{"summary":"List documents","description":"Lists documents. The documents listed can be limited by order ID, document type, the page or results per page.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"type":"pro_forma_invoice","number":9535,"numberWithPrefix":"reprehenderit","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":1,"source":"klarna","displayDate":"1986-10-11T10:54:33+01:00","status":"done"},{"type":"repair_bill","number":7382,"numberWithPrefix":"nihil","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":5,"source":"klarna","displayDate":"1981-11-22T10:22:35+01:00","status":"done"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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.\n * 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\n * of time. This filter can be used alone or can be combined with the CreatedAtFrom filter. The\n * 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.\n * 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\n * of time. This filter can be used alone or can be combined with the UpdatedAtFrom filter. The\n * 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.\n * 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\n * of time. This filter can be used alone or can be combined with the displayDateFrom filter. The\n * date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.","format":"string","in":"query"},{"name":"orderId","type":"integer","required":false,"description":"The ID of the order","format":"integer","in":"query"},{"name":"type","type":"string","required":false,"description":"The type of the order document. The available types are receipt, invoiceExternal, invoice,\n * deliveryNote, poDeliveryNote, creditNote, creditNoteExternal, orderConfirmation, offer,\n * dunningLetter, reversalDunningLetter, returnNote, successConfirmation, correction, uploaded.","format":"string","in":"query"},{"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 documents to list per page. The default number of documents per page is 50.\n * The maximum number is 6000.","format":"integer","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"This field is used for sorting. Default is 'id'.\n * Possible values are 'id', 'type', 'number', 'createdAt', 'displayDate'","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"The order to sort by. Default is 'desc'. Possible values are 'asc' and 'desc'.","format":"string","in":"query"}]}},"\/rest\/orders\/documents\/{documentId}":{"delete":{"summary":"Delete a document without an order relation","description":"Deletes a document that doesn't have an order relation","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":"documentId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get an order document.","description":"Gets an order document. The document id must be specified.","tags":["Document"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Document"},"examples":{"application\/json":{"type":"cancellation","number":96374725,"numberWithPrefix":"ut","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":11,"source":"soap","displayDate":"1973-01-22T00:59:59+01:00","status":"done"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"documentId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"type":"uploaded","number":63241416,"numberWithPrefix":"est","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":5,"source":"klarna","displayDate":"1984-10-16T01:37:44+01:00","status":"done"},{"type":"item","number":150,"numberWithPrefix":"voluptatem","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":5,"source":"soap","displayDate":"2013-09-30T12:21:03+02:00","status":"done"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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.\n * 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\n * of time. This filter can be used alone or can be combined with the CreatedAtFrom filter.\n * 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.\n * 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\n * of time. This filter can be used alone or can be combined with the UpdatedAtFrom filter.\n * 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.\n * 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\n * of time. This filter can be used alone or can be combined with the displayDateFrom filter.\n * 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,\n * posInvoice, posInvoiceCancellation, cancellation, zReport, invoiceExternal, invoice,\n * deliveryNote, poDeliveryNote, creditNote, creditNoteExternal, orderConfirmation, offer,\n * dunningLetter, reversalDunningLetter, returnNote, successConfirmation, correction, reversal,\n * 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":"array","required":false,"description":"Load additional relations for a document. Currently possible are:\n <ul>\n <li>'references' = The document reference objects that are associated with the document.<\/li>\n <\/ul>\n Example: <code>?with[]=references<\/code>","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/orders\/items\/dates":{"post":{"summary":"Create a date for an order item","description":"<b>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<br><ul>\n<li>1 = Deleted on<\/li>\n<li>2 = Created on<\/li>\n<li>3 = Paid date<\/li>\n<li>4 = Last update<\/li>\n<li>5 = Completed on<\/li>\n<li>6 = Return date<\/li>\n<li>7 = Payment due date<\/li>\n<li>8 = Estimated shipping date<\/li>\n<li>9 = Start date<\/li>\n<li>10 = End date<\/li>\n<li>11 = Possible delivery date<\/li>\n<li>12 = Market transfer date<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderItemDate"},"examples":{"application\/json":{"orderItemId":15068,"typeId":9,"date":"2019-01-14T09:46:16+01:00","createdAt":"2025-07-20T15:19:54+02:00","updatedAt":"2025-07-09T18:36:04+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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\n* Start date = 9\n* End date = 10\n* Estimated delivery date = 11 optional with orderItemId"},"date":{"type":"string"}}}}]}},"\/rest\/orders\/items\/dates\/{id}":{"delete":{"summary":"Delete a date of an order item","description":"<b>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":"<b>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<br><ul>\n<li>1 = Deleted on<\/li>\n<li>2 = Created on<\/li>\n<li>3 = Paid date<\/li>\n<li>4 = Last update<\/li>\n<li>5 = Completed on<\/li>\n<li>6 = Return date<\/li>\n<li>7 = Payment due date<\/li>\n<li>8 = Estimated shipping date<\/li>\n<li>9 = Start date<\/li>\n<li>10 = End date<\/li>\n<li>11 = Possible delivery date<\/li>\n<li>12 = Market transfer date<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderItemDate"},"examples":{"application\/json":{"orderItemId":66727,"typeId":9,"date":"2011-08-02T10:12:32+02:00","createdAt":"2025-07-15T22:21:47+02:00","updatedAt":"2025-02-02T14:16:12+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"<b>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"},"examples":{"application\/json":{"orderItemId":17693,"typeId":10,"date":"2005-02-17T13:38:30+01:00","createdAt":"2025-01-31T04:31:11+01:00","updatedAt":"2025-07-23T16:01:03+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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\n* Start date = 9\n* End date = 10\n* Estimated delivery date = 11 optional"},"date":{"type":"string"}}}}]}},"\/rest\/orders\/items\/outgoing_stocks":{"delete":{"summary":"Revert outgoing stock for order items","description":"<b>DEPRECATED: Use the following route: POST \/rest\/{orderType}\/{orderId}\/cancel_booking<\/b>\nReverts 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","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":"<b>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<br><ul>\n<li>1 = WAREHOUSE<\/li>\n<li>2 = SHIPPING_PROFILE<\/li>\n<li>3 = PAYMENT_METHOD<\/li>\n<li>11 = WEIGHT<\/li>\n<li>12 = WIDTH<\/li>\n<li>13 = LENGTH<\/li>\n<li>14 = HEIGHT<\/li>\n<li>16 = EXTERNAL_TOKEN_ID<\/li>\n<li>17 = EXTERNAL_ITEM_ID<\/li>\n<li>18 = COUPON_CODE<\/li>\n<li>19 = COUPON_TYPE<\/li>\n<li>20 = ORIGINAL_WAREHOUSE<\/li>\n<li>21 = ORIGINAL_QUANTITY<\/li>\n<li>22 = CATEGORY_ID<\/li>\n<li>23 = MARKET_FEE<\/li>\n<li>24 = STOCK_REVERSING<\/li>\n<li>25 = DISPUTE_STATUS<\/li>\n<li>26 = NO_CHANGE_BY_CONTACT<\/li>\n<li>29 = SIZE<\/li>\n<li>30 = LOCATION_RESERVED<\/li>\n<li>31 = EXTERNAL_SHIPMENT_ITEM_ID<\/li>\n<li>32 = PARTIAL_SHIPPING_COSTS<\/li>\n<li>33 = MAIN_DOCUMENT_NUMBER<\/li>\n<li>34 = SALES_TAX_ID_NUMBER<\/li>\n<li>35 = RETURNS_REASON<\/li>\n<li>36 = RETURNS_ITEM_STATUS<\/li>\n<li>37 = FULFILLMENT_CENTER_ID<\/li>\n<li>38 = FULFILLMENT_CENTER_COUNTRY_ISO<\/li>\n<li>39 = REORDER_ITEM_ID<\/li>\n<li>40 = LISTING_TYPE<\/li>\n<li>46 = SOLD_COUPON_CODE<\/li>\n<li>48 = ORDER_ITEM_STATE<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderItemProperty"},"examples":{"application\/json":{"orderItemId":31785,"typeId":8,"value":"natus","createdAt":"2025-03-06T15:27:59+01:00","updatedAt":"2025-01-31T03:45:12+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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\n* WAREHOUSE = 1\n* SHIPPING_PROFILE = 2\n* PAYMENT_METHOD = 3\n* WEIGHT = 11\n* WIDTH = 12\n* LENGTH = 13\n* HEIGHT = 14\n* EXTERNAL_TOKEN_ID = 16\n* EXTERNAL_ITEM_ID = 17\n* COUPON_CODE = 18\n* COUPON_TYPE = 19\n* ORIGINAL_WAREHOUSE = 20\n* ORIGINAL_QUANTITY = 21\n* CATEGORY_ID = 22\n* MARKET_FEE = 23\n* STOCK_REVERSING = 24\n* DISPUTE_STATUS = 25\n* NO_CHANGE_BY_CONTACT = 26\n* SIZE = 29\n* LOCATION_RESERVED = 30\n* EXTERNAL_SHIPMENT_ITEM_ID = 31\n* PARTIAL_SHIPPING_COSTS = 32\n* MAIN_DOCUMENT_NUMBER = 33\n* SALES_TAX_ID_NUMBER = 34\n* RETURNS_REASON = 35\n* RETURNS_ITEM_STATUS = 36\n* FULFILLMENT_CENTER_ID = 37\n* FULFILLMENT_CENTER_COUNTRY_ISO = 38\n* REORDER_ITEM_ID = 39\n* LISTING_TYPE = 40\n* SOLD_COUPON_CODE = 46\n* ORDER_ITEM_STATE = 48\n* SAP_ORDER_NUMBER = 50\n* DISCOUNT = 52\n* REORDER_ITEM_PACKAGE_UNIT = 53\n* REORDER_ITEM_MINIMUM_PURCHASE = 54\n* REORDER_ITEM_DELIVERY_TIME_IN_DAYS = 55\n* REORDER_ITEM_DISCOUNTABLE = 56\n* RETURNS_REMAINING_PERCENTAGE = 57\n* ORDER_PROPERTY_ID = 81\n* ORDER_PROPERTY_VALUE = 82\n* ORDER_PROPERTY_GROUP_ID = 83\n* WEEE_PICK_UP = 92 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":"<b>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.\n<b>DEPRECATED: Use the following route: GET \/rest\/orders\/{orderId}<\/b>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderItemProperty"},"examples":{"application\/json":{"orderItemId":64925,"typeId":6,"value":"ut","createdAt":"2025-08-03T23:58:22+02:00","updatedAt":"2025-06-27T23:48:39+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"<b>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"},"examples":{"application\/json":{"orderItemId":52971,"typeId":5,"value":"et","createdAt":"2025-06-14T23:20:24+02:00","updatedAt":"2025-02-21T18:36:48+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\n* WAREHOUSE = 1\n* SHIPPING_PROFILE = 2\n* PAYMENT_METHOD = 3\n* WEIGHT = 11\n* WIDTH = 12\n* LENGTH = 13\n* HEIGHT = 14\n* EXTERNAL_TOKEN_ID = 16\n* EXTERNAL_ITEM_ID = 17\n* COUPON_CODE = 18\n* COUPON_TYPE = 19\n* ORIGINAL_WAREHOUSE = 20\n* ORIGINAL_QUANTITY = 21\n* CATEGORY_ID = 22\n* MARKET_FEE = 23\n* STOCK_REVERSING = 24\n* DISPUTE_STATUS = 25\n* NO_CHANGE_BY_CONTACT = 26\n* SIZE = 29\n* LOCATION_RESERVED = 30\n* EXTERNAL_SHIPMENT_ITEM_ID = 31\n* PARTIAL_SHIPPING_COSTS = 32\n* MAIN_DOCUMENT_NUMBER = 33\n* SALES_TAX_ID_NUMBER = 34\n* RETURNS_REASON = 35\n* RETURNS_ITEM_STATUS = 36\n* FULFILLMENT_CENTER_ID = 37\n* FULFILLMENT_CENTER_COUNTRY_ISO = 38\n* REORDER_ITEM_ID = 39\n* LISTING_TYPE = 40\n* SOLD_COUPON_CODE = 46\n* ORDER_ITEM_STATE = 48\n* SAP_ORDER_NUMBER = 50\n* DISCOUNT = 52\n* REORDER_ITEM_PACKAGE_UNIT = 53\n* REORDER_ITEM_MINIMUM_PURCHASE = 54\n* REORDER_ITEM_DELIVERY_TIME_IN_DAYS = 55\n* REORDER_ITEM_DISCOUNTABLE = 56\n* RETURNS_REMAINING_PERCENTAGE = 57\n* ORDER_PROPERTY_ID = 81\n* ORDER_PROPERTY_VALUE = 82\n* ORDER_PROPERTY_GROUP_ID = 83\n* WEEE_PICK_UP = 92 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"orderItemId":876,"quantity":82.33,"userId":72,"identification":"ab","direction":"in","status":"regular","warehouseLocationId":308,"batch":"dolores","bestBeforeDate":"1979-10-15","createdAt":"2025-08-19T12:32:31+02:00","updatedAt":"2025-09-05T05:19:54+02:00","deliveryNoteNumber":"dolore"},{"orderItemId":212,"quantity":65.6,"userId":53,"identification":"esse","direction":"in","status":"regular","warehouseLocationId":796,"batch":"suscipit","bestBeforeDate":"1985-05-11","createdAt":"2025-08-10T19:12:44+02:00","updatedAt":"2025-08-31T01:35:10+02:00","deliveryNoteNumber":"autem"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"Specifies the properties of the order item transactions to be loaded.","format":"","in":"query","items":{"type":"string"}},{"name":"with","type":"array","required":false,"description":"Loads additional relations of the order item transactions. The available relations are 'orderItem' and 'warehouseLocation'.","format":"","in":"query","items":{"type":"string"}},{"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"}]},"post":{"summary":"Create order item transactions","description":"Creates multiple order item transactions.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/OrderItemTransaction"}},"examples":{"application\/json":[{"orderItemId":378,"quantity":77.87,"userId":93,"identification":"architecto","direction":"out","status":"cancelled","warehouseLocationId":887,"batch":"sequi","bestBeforeDate":"2013-01-20","createdAt":"2025-09-06T04:49:10+02:00","updatedAt":"2025-08-17T01:59:12+02:00","deliveryNoteNumber":"voluptatum"},{"orderItemId":713,"quantity":26.02,"userId":47,"identification":"voluptatem","direction":"out","status":"cancelled","warehouseLocationId":745,"batch":"odio","bestBeforeDate":"1997-02-20","createdAt":"2025-08-24T00:16:08+02:00","updatedAt":"2025-09-09T17:33:56+02:00","deliveryNoteNumber":"aut"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/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 <a href=\"#\/Order\/get_rest_orders_items_transactions\">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":"array","required":true,"description":"The IDs of the order item transactions.","format":"","in":"query","items":{"type":"integer"}},{"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"},"examples":{"application\/json":{"orderItemId":790,"quantity":50.32,"userId":5,"identification":"neque","direction":"in","status":"cancelled","warehouseLocationId":466,"batch":"minima","bestBeforeDate":"1990-04-01","createdAt":"2025-09-05T12:55:04+02:00","updatedAt":"2025-08-17T01:34:45+02:00","deliveryNoteNumber":"qui"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"deliveryNoteNumber":{"type":"string","description":"The delivery note number"}}}}]}},"\/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":"<b>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"}},"examples":{"application\/json":[{"orderItemId":35736,"typeId":10,"date":"1970-09-26T21:40:55+01:00","createdAt":"2025-04-24T02:24:56+02:00","updatedAt":"2025-02-05T01:34:08+01:00"},{"orderItemId":45440,"typeId":9,"date":"2015-04-03T18:19:05+02:00","createdAt":"2025-07-12T20:01:03+02:00","updatedAt":"2025-06-04T10:29:28+02:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"<b>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<br><ul>\n<li>1 = Deleted on<\/li>\n<li>2 = Created on<\/li>\n<li>3 = Paid date<\/li>\n<li>4 = Last update<\/li>\n<li>5 = Completed on<\/li>\n<li>6 = Return date<\/li>\n<li>7 = Payment due date<\/li>\n<li>8 = Estimated shipping date<\/li>\n<li>9 = Start date<\/li>\n<li>10 = End date<\/li>\n<li>11 = Possible delivery date<\/li>\n<li>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":"<b>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<br><ul>\n<li>1 = Deleted on<\/li>\n<li>2 = Created on<\/li>\n<li>3 = Paid date<\/li>\n<li>4 = Last update<\/li>\n<li>5 = Completed on<\/li>\n<li>6 = Return date<\/li>\n<li>7 = Payment due date<\/li>\n<li>8 = Estimated shipping date<\/li>\n<li>9 = Start date<\/li>\n<li>10 = End date<\/li>\n<li>11 = Possible delivery date<\/li>\n<li>12 = Market transfer date<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderItemDate"},"examples":{"application\/json":{"orderItemId":25784,"typeId":10,"date":"1983-11-04T10:38:49+01:00","createdAt":"2025-03-07T20:46:51+01:00","updatedAt":"2025-07-19T10:33:00+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"<b>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<br><ul>\n<li>1 = Deleted on<\/li>\n<li>2 = Created on<\/li>\n<li>3 = Paid date<\/li>\n<li>4 = Last update<\/li>\n<li>5 = Completed on<\/li>\n<li>6 = Return date<\/li>\n<li>7 = Payment due date<\/li>\n<li>8 = Estimated shipping date<\/li>\n<li>9 = Start date<\/li>\n<li>10 = End date<\/li>\n<li>11 = Possible delivery date<\/li>\n<li>12 = Market transfer date<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderItemDate"},"examples":{"application\/json":{"orderItemId":16415,"typeId":9,"date":"1992-01-08T08:48:04+01:00","createdAt":"2025-08-12T21:38:35+02:00","updatedAt":"2025-09-10T09:42:59+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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\n* Start date = 9\n* End date = 10\n* Estimated delivery date = 11 optional with orderItemId"},"date":{"type":"string"}}}}]},"put":{"summary":"Update a date of an order item by order item and date type","description":"<b>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<br><ul>\n<li>1 = Deleted on<\/li>\n<li>2 = Created on<\/li>\n<li>3 = Paid date<\/li>\n<li>4 = Last update<\/li>\n<li>5 = Completed on<\/li>\n<li>6 = Return date<\/li>\n<li>7 = Payment due date<\/li>\n<li>8 = Estimated shipping date<\/li>\n<li>9 = Start date<\/li>\n<li>10 = End date<\/li>\n<li>11 = Possible delivery date<\/li>\n<li>12 = Market transfer date<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderItemDate"},"examples":{"application\/json":{"orderItemId":42727,"typeId":10,"date":"1970-12-24T09:35:30+01:00","createdAt":"2025-02-26T02:03:02+01:00","updatedAt":"2025-07-25T03:33:00+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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\n* Start date = 9\n* End date = 10\n* Estimated delivery date = 11 optional"},"date":{"type":"string"}}}}]}},"\/rest\/orders\/items\/{orderItemId}\/properties":{"get":{"summary":"Get all order item properties","description":"<b>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"}},"examples":{"application\/json":[{"orderItemId":34155,"typeId":10,"value":"et","createdAt":"2025-08-09T08:00:49+02:00","updatedAt":"2025-01-26T21:51:49+01:00"},{"orderItemId":23434,"typeId":8,"value":"aut","createdAt":"2025-07-08T02:41:14+02:00","updatedAt":"2025-07-05T02:15:17+02:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"<b>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<br><ul>\n<li>1 = WAREHOUSE<\/li>\n<li>2 = SHIPPING_PROFILE<\/li>\n<li>3 = PAYMENT_METHOD<\/li>\n<li>11 = WEIGHT<\/li>\n<li>12 = WIDTH<\/li>\n<li>13 = LENGTH<\/li>\n<li>14 = HEIGHT<\/li>\n<li>16 = EXTERNAL_TOKEN_ID<\/li>\n<li>17 = EXTERNAL_ITEM_ID<\/li>\n<li>18 = COUPON_CODE<\/li>\n<li>19 = COUPON_TYPE<\/li>\n<li>20 = ORIGINAL_WAREHOUSE<\/li>\n<li>21 = ORIGINAL_QUANTITY<\/li>\n<li>22 = CATEGORY_ID<\/li>\n<li>23 = MARKET_FEE<\/li>\n<li>24 = STOCK_REVERSING<\/li>\n<li>25 = DISPUTE_STATUS<\/li>\n<li>26 = NO_CHANGE_BY_CONTACT<\/li>\n<li>29 = SIZE<\/li>\n<li>30 = LOCATION_RESERVED<\/li>\n<li>31 = EXTERNAL_SHIPMENT_ITEM_ID<\/li>\n<li>32 = PARTIAL_SHIPPING_COSTS<\/li>\n<li>33 = MAIN_DOCUMENT_NUMBER<\/li>\n<li>34 = SALES_TAX_ID_NUMBER<\/li>\n<li>35 = RETURNS_REASON<\/li>\n<li>36 = RETURNS_ITEM_STATUS<\/li>\n<li>37 = FULFILLMENT_CENTER_ID<\/li>\n<li>38 = FULFILLMENT_CENTER_COUNTRY_ISO<\/li>\n<li>39 = REORDER_ITEM_ID<\/li>\n<li>40 = LISTING_TYPE<\/li>\n<li>46 = SOLD_COUPON_CODE<\/li>\n<li>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":"<b>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<br><ul>\n<li>1 = WAREHOUSE<\/li>\n<li>2 = SHIPPING_PROFILE<\/li>\n<li>3 = PAYMENT_METHOD<\/li>\n<li>11 = WEIGHT<\/li>\n<li>12 = WIDTH<\/li>\n<li>13 = LENGTH<\/li>\n<li>14 = HEIGHT<\/li>\n<li>16 = EXTERNAL_TOKEN_ID<\/li>\n<li>17 = EXTERNAL_ITEM_ID<\/li>\n<li>18 = COUPON_CODE<\/li>\n<li>19 = COUPON_TYPE<\/li>\n<li>20 = ORIGINAL_WAREHOUSE<\/li>\n<li>21 = ORIGINAL_QUANTITY<\/li>\n<li>22 = CATEGORY_ID<\/li>\n<li>23 = MARKET_FEE<\/li>\n<li>24 = STOCK_REVERSING<\/li>\n<li>25 = DISPUTE_STATUS<\/li>\n<li>26 = NO_CHANGE_BY_CONTACT<\/li>\n<li>29 = SIZE<\/li>\n<li>30 = LOCATION_RESERVED<\/li>\n<li>31 = EXTERNAL_SHIPMENT_ITEM_ID<\/li>\n<li>32 = PARTIAL_SHIPPING_COSTS<\/li>\n<li>33 = MAIN_DOCUMENT_NUMBER<\/li>\n<li>34 = SALES_TAX_ID_NUMBER<\/li>\n<li>35 = RETURNS_REASON<\/li>\n<li>36 = RETURNS_ITEM_STATUS<\/li>\n<li>37 = FULFILLMENT_CENTER_ID<\/li>\n<li>38 = FULFILLMENT_CENTER_COUNTRY_ISO<\/li>\n<li>39 = REORDER_ITEM_ID<\/li>\n<li>40 = LISTING_TYPE<\/li>\n<li>46 = SOLD_COUPON_CODE<\/li>\n<li>48 = ORDER_ITEM_STATE<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderItemProperty"},"examples":{"application\/json":{"orderItemId":41552,"typeId":2,"value":"eos","createdAt":"2025-02-19T15:02:07+01:00","updatedAt":"2025-03-12T05:33:10+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"<b>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<br><ul>\n<li>1 = WAREHOUSE<\/li>\n<li>2 = SHIPPING_PROFILE<\/li>\n<li>3 = PAYMENT_METHOD<\/li>\n<li>11 = WEIGHT<\/li>\n<li>12 = WIDTH<\/li>\n<li>13 = LENGTH<\/li>\n<li>14 = HEIGHT<\/li>\n<li>16 = EXTERNAL_TOKEN_ID<\/li>\n<li>17 = EXTERNAL_ITEM_ID<\/li>\n<li>18 = COUPON_CODE<\/li>\n<li>19 = COUPON_TYPE<\/li>\n<li>20 = ORIGINAL_WAREHOUSE<\/li>\n<li>21 = ORIGINAL_QUANTITY<\/li>\n<li>22 = CATEGORY_ID<\/li>\n<li>23 = MARKET_FEE<\/li>\n<li>24 = STOCK_REVERSING<\/li>\n<li>25 = DISPUTE_STATUS<\/li>\n<li>26 = NO_CHANGE_BY_CONTACT<\/li>\n<li>29 = SIZE<\/li>\n<li>30 = LOCATION_RESERVED<\/li>\n<li>31 = EXTERNAL_SHIPMENT_ITEM_ID<\/li>\n<li>32 = PARTIAL_SHIPPING_COSTS<\/li>\n<li>33 = MAIN_DOCUMENT_NUMBER<\/li>\n<li>34 = SALES_TAX_ID_NUMBER<\/li>\n<li>35 = RETURNS_REASON<\/li>\n<li>36 = RETURNS_ITEM_STATUS<\/li>\n<li>37 = FULFILLMENT_CENTER_ID<\/li>\n<li>38 = FULFILLMENT_CENTER_COUNTRY_ISO<\/li>\n<li>39 = REORDER_ITEM_ID<\/li>\n<li>40 = LISTING_TYPE<\/li>\n<li>46 = SOLD_COUPON_CODE<\/li>\n<li>48 = ORDER_ITEM_STATE<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderItemProperty"},"examples":{"application\/json":{"orderItemId":66028,"typeId":16,"value":"accusantium","createdAt":"2025-07-22T01:35:09+02:00","updatedAt":"2025-05-22T13:59:56+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 with typeId"},"typeId":{"type":"integer","description":"The ID of the property type.\n\n* WAREHOUSE = 1\n* SHIPPING_PROFILE = 2\n* PAYMENT_METHOD = 3\n* WEIGHT = 11\n* WIDTH = 12\n* LENGTH = 13\n* HEIGHT = 14\n* EXTERNAL_TOKEN_ID = 16\n* EXTERNAL_ITEM_ID = 17\n* COUPON_CODE = 18\n* COUPON_TYPE = 19\n* ORIGINAL_WAREHOUSE = 20\n* ORIGINAL_QUANTITY = 21\n* CATEGORY_ID = 22\n* MARKET_FEE = 23\n* STOCK_REVERSING = 24\n* DISPUTE_STATUS = 25\n* NO_CHANGE_BY_CONTACT = 26\n* SIZE = 29\n* LOCATION_RESERVED = 30\n* EXTERNAL_SHIPMENT_ITEM_ID = 31\n* PARTIAL_SHIPPING_COSTS = 32\n* MAIN_DOCUMENT_NUMBER = 33\n* SALES_TAX_ID_NUMBER = 34\n* RETURNS_REASON = 35\n* RETURNS_ITEM_STATUS = 36\n* FULFILLMENT_CENTER_ID = 37\n* FULFILLMENT_CENTER_COUNTRY_ISO = 38\n* REORDER_ITEM_ID = 39\n* LISTING_TYPE = 40\n* SOLD_COUPON_CODE = 46\n* ORDER_ITEM_STATE = 48\n* SAP_ORDER_NUMBER = 50\n* DISCOUNT = 52\n* REORDER_ITEM_PACKAGE_UNIT = 53\n* REORDER_ITEM_MINIMUM_PURCHASE = 54\n* REORDER_ITEM_DELIVERY_TIME_IN_DAYS = 55\n* REORDER_ITEM_DISCOUNTABLE = 56\n* RETURNS_REMAINING_PERCENTAGE = 57\n* ORDER_PROPERTY_ID = 81\n* ORDER_PROPERTY_VALUE = 82\n* ORDER_PROPERTY_GROUP_ID = 83\n* WEEE_PICK_UP = 92 optional with orderItemId"},"value":{"type":"string","description":"The value of the property. The value depends on type."}}}}]},"put":{"summary":"Update order item property","description":"<b>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<br><ul>\n<li>1 = WAREHOUSE<\/li>\n<li>2 = SHIPPING_PROFILE<\/li>\n<li>3 = PAYMENT_METHOD<\/li>\n<li>11 = WEIGHT<\/li>\n<li>12 = WIDTH<\/li>\n<li>13 = LENGTH<\/li>\n<li>14 = HEIGHT<\/li>\n<li>16 = EXTERNAL_TOKEN_ID<\/li>\n<li>17 = EXTERNAL_ITEM_ID<\/li>\n<li>18 = COUPON_CODE<\/li>\n<li>19 = COUPON_TYPE<\/li>\n<li>20 = ORIGINAL_WAREHOUSE<\/li>\n<li>21 = ORIGINAL_QUANTITY<\/li>\n<li>22 = CATEGORY_ID<\/li>\n<li>23 = MARKET_FEE<\/li>\n<li>24 = STOCK_REVERSING<\/li>\n<li>25 = DISPUTE_STATUS<\/li>\n<li>26 = NO_CHANGE_BY_CONTACT<\/li>\n<li>29 = SIZE<\/li>\n<li>30 = LOCATION_RESERVED<\/li>\n<li>31 = EXTERNAL_SHIPMENT_ITEM_ID<\/li>\n<li>32 = PARTIAL_SHIPPING_COSTS<\/li>\n<li>33 = MAIN_DOCUMENT_NUMBER<\/li>\n<li>34 = SALES_TAX_ID_NUMBER<\/li>\n<li>35 = RETURNS_REASON<\/li>\n<li>36 = RETURNS_ITEM_STATUS<\/li>\n<li>37 = FULFILLMENT_CENTER_ID<\/li>\n<li>38 = FULFILLMENT_CENTER_COUNTRY_ISO<\/li>\n<li>39 = REORDER_ITEM_ID<\/li>\n<li>40 = LISTING_TYPE<\/li>\n<li>46 = SOLD_COUPON_CODE<\/li>\n<li>48 = ORDER_ITEM_STATE<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderItemProperty"},"examples":{"application\/json":{"orderItemId":32335,"typeId":2,"value":"harum","createdAt":"2025-05-15T03:07:39+02:00","updatedAt":"2025-06-15T13:06:44+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\n* WAREHOUSE = 1\n* SHIPPING_PROFILE = 2\n* PAYMENT_METHOD = 3\n* WEIGHT = 11\n* WIDTH = 12\n* LENGTH = 13\n* HEIGHT = 14\n* EXTERNAL_TOKEN_ID = 16\n* EXTERNAL_ITEM_ID = 17\n* COUPON_CODE = 18\n* COUPON_TYPE = 19\n* ORIGINAL_WAREHOUSE = 20\n* ORIGINAL_QUANTITY = 21\n* CATEGORY_ID = 22\n* MARKET_FEE = 23\n* STOCK_REVERSING = 24\n* DISPUTE_STATUS = 25\n* NO_CHANGE_BY_CONTACT = 26\n* SIZE = 29\n* LOCATION_RESERVED = 30\n* EXTERNAL_SHIPMENT_ITEM_ID = 31\n* PARTIAL_SHIPPING_COSTS = 32\n* MAIN_DOCUMENT_NUMBER = 33\n* SALES_TAX_ID_NUMBER = 34\n* RETURNS_REASON = 35\n* RETURNS_ITEM_STATUS = 36\n* FULFILLMENT_CENTER_ID = 37\n* FULFILLMENT_CENTER_COUNTRY_ISO = 38\n* REORDER_ITEM_ID = 39\n* LISTING_TYPE = 40\n* SOLD_COUPON_CODE = 46\n* ORDER_ITEM_STATE = 48\n* SAP_ORDER_NUMBER = 50\n* DISCOUNT = 52\n* REORDER_ITEM_PACKAGE_UNIT = 53\n* REORDER_ITEM_MINIMUM_PURCHASE = 54\n* REORDER_ITEM_DELIVERY_TIME_IN_DAYS = 55\n* REORDER_ITEM_DISCOUNTABLE = 56\n* RETURNS_REMAINING_PERCENTAGE = 57\n* ORDER_PROPERTY_ID = 81\n* ORDER_PROPERTY_VALUE = 82\n* ORDER_PROPERTY_GROUP_ID = 83\n* WEEE_PICK_UP = 92 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"}},"examples":{"application\/json":[{"orderItemId":867,"quantity":34.52,"userId":72,"identification":"ex","direction":"in","status":"regular","warehouseLocationId":566,"batch":"provident","bestBeforeDate":"1994-02-19","createdAt":"2025-09-08T19:39:05+02:00","updatedAt":"2025-09-08T02:03:38+02:00","deliveryNoteNumber":"corrupti"},{"orderItemId":733,"quantity":15.7,"userId":96,"identification":"rerum","direction":"in","status":"regular","warehouseLocationId":201,"batch":"quod","bestBeforeDate":"1981-12-27","createdAt":"2025-09-08T03:19:27+02:00","updatedAt":"2025-08-25T21:31:57+02:00","deliveryNoteNumber":"debitis"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The properties to be loaded","format":"","in":"query","items":{"type":"string"}},{"name":"with","type":"array","required":false,"description":"Load additional relations for a transaction. Currently possible are 'orderItem' and 'warehouseLocation'.","format":"","in":"query","items":{"type":"string"}}]},"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"},"examples":{"application\/json":{"orderItemId":441,"quantity":95.59,"userId":29,"identification":"officiis","direction":"in","status":"cancelled","warehouseLocationId":240,"batch":"eveniet","bestBeforeDate":"1975-11-28","createdAt":"2025-09-02T20:46:43+02:00","updatedAt":"2025-08-11T17:08:22+02:00","deliveryNoteNumber":"odio"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"deliveryNoteNumber":{"type":"string","description":"The delivery note number"}}}}]}},"\/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<br><ul>\n<li>1 = WAREHOUSE<\/li>\n<li>2 = SHIPPING_PROFILE<\/li>\n<li>3 = PAYMENT_METHOD<\/li>\n<li>4 = PAYMENT_STATUS<\/li>\n<li>5 = EXTERNAL_SHIPPING_PROFILE<\/li>\n<li>6 = DOCUMENT_LANGUAGE<\/li>\n<li>7 = EXTERNAL_ORDER_ID<\/li>\n<li>8 = CUSTOMER_SIGN<\/li>\n<li>9 = DUNNING_LEVEL<\/li>\n<li>10 = SELLER_ACCOUNT<\/li>\n<li>11 = WEIGHT<\/li>\n<li>12 = WIDTH<\/li>\n<li>13 = LENGTH<\/li>\n<li>14 = HEIGHT<\/li>\n<li>15 = FLAG<\/li>\n<li>16 = EXTERNAL_TOKEN_ID<\/li>\n<li>17 = EXTERNAL_ITEM_ID<\/li>\n<li>18 = COUPON_CODE<\/li>\n<li>19 = COUPON_TYPE<\/li>\n<li>33 = MAIN_DOCUMENT_NUMBER<\/li>\n<li>34 = SALES_TAX_ID_NUMBER<\/li>\n<li>45 = PAYMENT_TRANSACTION_ID<\/li>\n<li>47 = EXTERNAL_TAX_SERVICE<\/li>\n<li>60 = MERCHANT_ID<\/li>\n<li>61 = REPORT_ID<\/li>\n<li>63 = PREFERRED_STORAGE_LOCATION_ID<\/li>\n<li>64 = AMAZON_SHIPPING_LABEL<\/li>\n<li>994 = EBAY_PLUS<\/li>\n<li>995 = FULFILLMENT_SERVICE<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/OrderPropertyType"}},"examples":{"application\/json":[{"id":1603,"isErasable":false,"position":44,"cast":"int"},{"id":1734,"isErasable":false,"position":5,"cast":"numeric"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","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":"","in":"query","items":{"type":"string"}}]},"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"},"examples":{"application\/json":{"id":2666,"isErasable":true,"position":90,"cast":"numeric"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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* string\n* int\n* numeric\n* bool\n* enum(val1,val2,val3,...) 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<br><ul>\n<li>1 = WAREHOUSE<\/li>\n<li>2 = SHIPPING_PROFILE<\/li>\n<li>3 = PAYMENT_METHOD<\/li>\n<li>4 = PAYMENT_STATUS<\/li>\n<li>5 = EXTERNAL_SHIPPING_PROFILE<\/li>\n<li>6 = DOCUMENT_LANGUAGE<\/li>\n<li>7 = EXTERNAL_ORDER_ID<\/li>\n<li>8 = CUSTOMER_SIGN<\/li>\n<li>9 = DUNNING_LEVEL<\/li>\n<li>10 = SELLER_ACCOUNT<\/li>\n<li>11 = WEIGHT<\/li>\n<li>12 = WIDTH<\/li>\n<li>13 = LENGTH<\/li>\n<li>14 = HEIGHT<\/li>\n<li>15 = FLAG<\/li>\n<li>16 = EXTERNAL_TOKEN_ID<\/li>\n<li>17 = EXTERNAL_ITEM_ID<\/li>\n<li>18 = COUPON_CODE<\/li>\n<li>19 = COUPON_TYPE<\/li>\n<li>33 = MAIN_DOCUMENT_NUMBER<\/li>\n<li>34 = SALES_TAX_ID_NUMBER<\/li>\n<li>45 = PAYMENT_TRANSACTION_ID<\/li>\n<li>47 = EXTERNAL_TAX_SERVICE<\/li>\n<li>60 = MERCHANT_ID<\/li>\n<li>61 = REPORT_ID<\/li>\n<li>63 = PREFERRED_STORAGE_LOCATION_ID<\/li>\n<li>64 = AMAZON_SHIPPING_LABEL<\/li>\n<li>994 = EBAY_PLUS<\/li>\n<li>995 = FULFILLMENT_SERVICE<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderPropertyType"},"examples":{"application\/json":{"id":1504,"isErasable":true,"position":83,"cast":"enum(val1,val2,val3)"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","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":"","in":"query","items":{"type":"string"}}]},"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"},"examples":{"application\/json":{"id":1761,"isErasable":true,"position":10,"cast":"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":"typeId","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"in":"body","name":"\/rest\/orders\/properties\/types\/{typeId}","schema":{"type":"object","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":"<b>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":"<b>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"},"examples":{"application\/json":{"orderId":103,"typeId":19,"value":"est","createdAt":"2025-02-11T16:09:15+01:00","updatedAt":"2025-08-31T17:57:19+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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 = 1\n* SHIPPING_PROFILE = 2\n* PAYMENT_METHOD = 3\n* PAYMENT_STATUS = 4\n* EXTERNAL_SHIPPING_PROFILE = 5\n* DOCUMENT_LANGUAGE = 6\n* EXTERNAL_ORDER_ID = 7\n* CUSTOMER_SIGN = 8\n* DUNNING_LEVEL = 9\n* SELLER_ACCOUNT = 10\n* WEIGHT = 11\n* WIDTH = 12\n* LENGTH = 13\n* HEIGHT = 14\n* FLAG = 15\n* EXTERNAL_TOKEN_ID = 16\n* EXTERNAL_ITEM_ID = 17\n* COUPON_CODE = 18\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* MARKET_TAX_ID = 88\n* MARKET_EORI = 89\n* IS_REVERSE_CHARGED = 90\n* DISALLOW_INTERNAL_TAX_RELEVANT_DOCUMENTS = 91\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"}},"examples":{"application\/json":[{"id":17.29,"isEditable":true,"backendName":"Herkunft 17.29","name":"HK 17.29","orderOwnerId":14,"isFilterable":true,"origin":"some.plugin.name"},{"id":78.29,"isEditable":false,"backendName":"Herkunft 78.29","name":"HK 78.29","orderOwnerId":7,"isFilterable":true,"origin":"plenty"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The desired columns\/attributes of the order referrer to be loaded.","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/orders\/referrers\/next_free_main":{"get":{"summary":"Get next free main referrer ID","description":"Gets the next free main referrer ID. If no more free main referrers are available, an exception is thrown.","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."}}}},"\/rest\/orders\/referrers\/search":{"get":{"summary":"Search for referrers","description":"Search for referrers 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 OrderReferrer","items":{"$ref":"#\/definitions\/OrderReferrer"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"id":39.67,"isEditable":true,"backendName":"Herkunft 39.67","name":"HK 39.67","orderOwnerId":16,"isFilterable":true,"origin":"some.plugin.name"},{"id":63.45,"isEditable":true,"backendName":"Herkunft 63.45","name":"HK 63.45","orderOwnerId":11,"isFilterable":true,"origin":"some.plugin.name"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 referrers per page is 20.","format":"integer","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"Sort search result according to specified field. The default value is id.","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":"id","type":"integer","required":false,"description":"The ID of the referrer.","format":"integer","in":"query"},{"name":"name","type":"integer","required":false,"description":"The name of the referrer.","format":"integer","in":"query"}]}},"\/rest\/orders\/referrers\/{parentReferrerId}":{"post":{"summary":"Create an order referrer","description":"Create an order referrer. The ID can be specified, a parent ID can be specified to create a sub referrer or if no ID is specified, a referrer ID will be assigned automatically.\nIf an ID is specified, the ID may not be used already. If the ID is used already, the referrer will only be created.\nIf the ID is automatically assigned, the first ID that has not been used before will be set.\nIf the ID is not specified, but a parent referrer ID is given, then the new referrer ID will be a sub referrer of the given parent.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderReferrer"},"examples":{"application\/json":{"id":24.72,"isEditable":true,"backendName":"Herkunft 24.72","name":"HK 24.72","orderOwnerId":16,"isFilterable":true,"origin":"plenty"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"data","type":"array","required":true,"description":"The attributes of the order referrer to be created.","format":"","in":"query","items":{"type":"string"}},{"name":"parentReferrerId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/orders\/referrers\/{referrerId}":{"delete":{"summary":"Delete referrer","description":"Delete a referrer. The ID of the referrer 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":"referrerId","type":"integer","required":true,"description":"The ID of the referrer.","format":"integer","in":"path"}]},"get":{"summary":"Get a referrer","description":"Gets a referrer. The ID of the referrer must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderReferrer"},"examples":{"application\/json":{"id":54.37,"isEditable":true,"backendName":"Herkunft 54.37","name":"HK 54.37","orderOwnerId":1,"isFilterable":true,"origin":"some.plugin.name"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"The ID of the referrer.","format":"integer","in":"path"}]},"put":{"summary":"Update referrer","description":"Update a referrer. The ID of the referrer must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderReferrer"},"examples":{"application\/json":{"id":77.52,"isEditable":false,"backendName":"Herkunft 77.52","name":"HK 77.52","orderOwnerId":7,"isFilterable":true,"origin":"some.plugin.name"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"The ID of the referrer.","format":"integer","in":"path"}]}},"\/rest\/orders\/search":{"get":{"summary":"Search orders","description":"Searches for orders. The results can be restricted by using filters. For more information on the order search, refer to the <a href='https:\/\/developers.plentymarkets.com\/en-gb\/developers\/main\/rest-api-guides\/order-search.html' target='_blank'>REST API guide<\/a>.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"statusName":"","plentyId":65411,"typeId":6,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]},{"statusName":"","plentyId":65411,"typeId":7,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"This filter restricts the search results to orders with a specific ID.","format":"integer","in":"query"},{"name":"plentyId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific plenty ID.","format":"integer","in":"query"},{"name":"orderTypeId","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific order type ID.","format":"string","in":"query"},{"name":"statusId","type":"number","required":false,"description":"This filter restricts the search results to orders with a specific status ID.","format":"number","in":"query"},{"name":"referrerId","type":"number","required":false,"description":"This filter restricts the search results to orders with a specific referrer ID.","format":"number","in":"query"},{"name":"ownerId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific owner ID.","format":"integer","in":"query"},{"name":"locationId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific location ID.","format":"integer","in":"query"},{"name":"updatedAt","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific update date.","format":"string","in":"query"},{"name":"createdAt","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific creation date.","format":"string","in":"query"},{"name":"lockStatus","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific lock status.","format":"string","in":"query"},{"name":"orderAddressData","type":"string","required":false,"description":"This filter restricts the search results to orders with specific address data.","format":"string","in":"query"},{"name":"contactData","type":"string","required":false,"description":"This filter restricts the search results to orders with specific contact data.","format":"string","in":"query"},{"name":"orderItemTypeId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific order item type ID.","format":"integer","in":"query"},{"name":"itemId","type":"integer","required":false,"description":"This filter restricts the search results to orders including a specific item.","format":"integer","in":"query"},{"name":"itemVariationId","type":"integer","required":false,"description":"This filter restricts the search results to orders including a specific item variation.","format":"integer","in":"query"},{"name":"variationNumber","type":"string","required":false,"description":"This filter restricts the search results to orders including a specific variation number.","format":"string","in":"query"},{"name":"orderItemName","type":"string","required":false,"description":"This filter restricts the search results to orders including a specific order item name.","format":"string","in":"query"},{"name":"documentNumber","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific document number.","format":"string","in":"query"},{"name":"hasValidInvoice","type":"boolean","required":false,"description":"This filter restricts the search results to orders for which a valid invoice exists.","format":"boolean","in":"query"},{"name":"packageNumber","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific package number.","format":"string","in":"query"},{"name":"contactClassId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific contact class ID.","format":"integer","in":"query"},{"name":"itemManufacturerId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific item manufacturer ID.","format":"integer","in":"query"},{"name":"orderItemWarehouseId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific order item warehouse ID.","format":"integer","in":"query"},{"name":"invoiceTotalSystemCurrency","type":"number","required":false,"description":"This filter restricts the search results to orders with a specific invoice total (in system currency).","format":"number","in":"query"},{"name":"isDeliveryAddressPackingStation","type":"boolean","required":false,"description":"This filter restricts the search results to orders for which the delivery address is a packing station.","format":"boolean","in":"query"},{"name":"serialNumber","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific serial number.","format":"string","in":"query"},{"name":"isGuestContact","type":"boolean","required":false,"description":"This filter restricts the search results to orders with a guest contact.","format":"boolean","in":"query"},{"name":"variationSupplierId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific variation supplier ID.","format":"integer","in":"query"},{"name":"orderItemReferrerId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific order item referrer ID.","format":"integer","in":"query"},{"name":"tag","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific tag.","format":"integer","in":"query"},{"name":"excludeMainOrders","type":"boolean","required":false,"description":"This filter restricts the search results to orders for which no delivery orders exist.","format":"boolean","in":"query"},{"name":"orderProperty_{typeId}","type":"string","required":false,"description":"This filter restricts the search results to orders with an order property with a specific value. The order property type ID has to be replaced in the filter name.","format":"string","in":"query"},{"name":"orderDate_{typeId}","type":"string","required":false,"description":"This filter restricts the search results to orders with an order date with a specific value. The order date type ID has to be replaced in the filter name.","format":"string","in":"query"},{"name":"orderReference_{referenceType}","type":"integer","required":false,"description":"This filter restricts the search results to orders with an order reference with a specific value. The order reference type has to be replaced in the filter name.","format":"integer","in":"query"},{"name":"orderItemReference_{referenceType}","type":"integer","required":false,"description":"This filter restricts the search results to orders with an order item reference with a specific value. The order item reference type has to be replaced in the filter name.","format":"integer","in":"query"},{"name":"relationReference_{referenceType}_{relationType}","type":"integer","required":false,"description":"This filter restricts the search results to orders with a relation reference with a specific value. The reference type and relation type has to be replaced in the filter name.","format":"integer","in":"query"},{"name":"soldCouponCode","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific sold coupon code.","format":"string","in":"query"},{"name":"redeemedCouponCode","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific redeemed coupon code.","format":"string","in":"query"},{"name":"orderBillingAddressCountryId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific invoice address country ID.","format":"integer","in":"query"},{"name":"orderDeliveryAddressCountryId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific delivery address country ID.","format":"integer","in":"query"},{"name":"documentNumber_{documentType}","type":"string","required":false,"description":"This filter restricts the search results to orders with a document number with a specific value. The document type has to be replaced in the filter name.","format":"string","in":"query"},{"name":"orderItemProperty_{typeId}","type":"string","required":false,"description":"This filter restricts the search results to orders with an order item property with a specific value. The order property type ID has to be replaced in the filter name.","format":"string","in":"query"},{"name":"addressRelation_{typeId}","type":"integer","required":false,"description":"This filter restricts the search results to orders with an address relation with a specific value. The address relation type ID has to be replaced in the filter name.","format":"integer","in":"query"},{"name":"shippingServiceProviderId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific shipping service provider ID.","format":"integer","in":"query"},{"name":"shippingServiceProviderType","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific shipping service provider type.","format":"string","in":"query"},{"name":"shippingStatus","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific shipping status.","format":"string","in":"query"},{"name":"shippingShipmentDate","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific shipment date.","format":"string","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"This field is used for sorting. Default is 'orderId'. Possible values are 'orderId', 'statusId', 'orderDeliveryAddressPostCode', 'invoiceNumber', 'orderDate_{2,3,5,8}', 'orderProperty_33'","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"The order to sort by. Possible values are 'asc' and 'desc'.","format":"string","in":"query"},{"name":"page","type":"integer","required":false,"description":"The page to get. The returned default page 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 displayed per page is 50.","format":"integer","in":"query"},{"name":"with","type":"array","required":false,"description":"Load additional relations for an order.","format":"","in":"query","items":{"type":"string"}},{"name":"lazyLoaded","type":"boolean","required":false,"description":"If true, no default relations are loaded. Default = true.","format":"boolean","in":"query"},{"name":"withDeleted","type":"boolean","required":false,"description":"If true, include deleted orders in result. Default = false.","format":"boolean","in":"query"}]},"post":{"summary":"Search orders","description":"Searches for orders. The results can be restricted by using filters. For more information on the order search, refer to the <a href='https:\/\/developers.plentymarkets.com\/en-gb\/developers\/main\/rest-api-guides\/order-search.html' target='_blank'>REST API guide<\/a>.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"statusName":"","plentyId":65411,"typeId":7,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]},{"statusName":"","plentyId":65411,"typeId":7,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"This filter restricts the search results to orders with a specific ID.","format":"integer","in":"query"},{"name":"plentyId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific plenty ID.","format":"integer","in":"query"},{"name":"orderTypeId","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific order type ID.","format":"string","in":"query"},{"name":"statusId","type":"number","required":false,"description":"This filter restricts the search results to orders with a specific status ID.","format":"number","in":"query"},{"name":"referrerId","type":"number","required":false,"description":"This filter restricts the search results to orders with a specific referrer ID.","format":"number","in":"query"},{"name":"ownerId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific owner ID.","format":"integer","in":"query"},{"name":"locationId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific location ID.","format":"integer","in":"query"},{"name":"updatedAt","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific update date.","format":"string","in":"query"},{"name":"createdAt","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific creation date.","format":"string","in":"query"},{"name":"lockStatus","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific lock status.","format":"string","in":"query"},{"name":"orderAddressData","type":"string","required":false,"description":"This filter restricts the search results to orders with specific address data.","format":"string","in":"query"},{"name":"contactData","type":"string","required":false,"description":"This filter restricts the search results to orders with specific contact data.","format":"string","in":"query"},{"name":"orderItemTypeId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific order item type ID.","format":"integer","in":"query"},{"name":"itemId","type":"integer","required":false,"description":"This filter restricts the search results to orders including a specific item.","format":"integer","in":"query"},{"name":"itemVariationId","type":"integer","required":false,"description":"This filter restricts the search results to orders including a specific item variation.","format":"integer","in":"query"},{"name":"variationNumber","type":"string","required":false,"description":"This filter restricts the search results to orders including a specific variation number.","format":"string","in":"query"},{"name":"orderItemName","type":"string","required":false,"description":"This filter restricts the search results to orders including a specific order item name.","format":"string","in":"query"},{"name":"documentNumber","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific document number.","format":"string","in":"query"},{"name":"hasValidInvoice","type":"boolean","required":false,"description":"This filter restricts the search results to orders for which a valid invoice exists.","format":"boolean","in":"query"},{"name":"packageNumber","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific package number.","format":"string","in":"query"},{"name":"contactClassId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific contact class ID.","format":"integer","in":"query"},{"name":"itemManufacturerId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific item manufacturer ID.","format":"integer","in":"query"},{"name":"orderItemWarehouseId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific order item warehouse ID.","format":"integer","in":"query"},{"name":"invoiceTotalSystemCurrency","type":"number","required":false,"description":"This filter restricts the search results to orders with a specific invoice total (in system currency).","format":"number","in":"query"},{"name":"isDeliveryAddressPackingStation","type":"boolean","required":false,"description":"This filter restricts the search results to orders for which the delivery address is a packing station.","format":"boolean","in":"query"},{"name":"serialNumber","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific serial number.","format":"string","in":"query"},{"name":"isGuestContact","type":"boolean","required":false,"description":"This filter restricts the search results to orders with a guest contact.","format":"boolean","in":"query"},{"name":"variationSupplierId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific variation supplier ID.","format":"integer","in":"query"},{"name":"orderItemReferrerId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific order item referrer ID.","format":"integer","in":"query"},{"name":"tag","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific tag.","format":"integer","in":"query"},{"name":"excludeMainOrders","type":"boolean","required":false,"description":"This filter restricts the search results to orders for which no delivery orders exist.","format":"boolean","in":"query"},{"name":"orderProperty_{typeId}","type":"string","required":false,"description":"This filter restricts the search results to orders with an order property with a specific value. The order property type ID has to be replaced in the filter name.","format":"string","in":"query"},{"name":"orderDate_{typeId}","type":"string","required":false,"description":"This filter restricts the search results to orders with an order date with a specific value. The order date type ID has to be replaced in the filter name.","format":"string","in":"query"},{"name":"orderReference_{referenceType}","type":"integer","required":false,"description":"This filter restricts the search results to orders with an order reference with a specific value. The order reference type has to be replaced in the filter name.","format":"integer","in":"query"},{"name":"orderItemReference_{referenceType}","type":"integer","required":false,"description":"This filter restricts the search results to orders with an order item reference with a specific value. The order item reference type has to be replaced in the filter name.","format":"integer","in":"query"},{"name":"relationReference_{referenceType}_{relationType}","type":"integer","required":false,"description":"This filter restricts the search results to orders with a relation reference with a specific value. The reference type and relation type has to be replaced in the filter name.","format":"integer","in":"query"},{"name":"soldCouponCode","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific sold coupon code.","format":"string","in":"query"},{"name":"redeemedCouponCode","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific redeemed coupon code.","format":"string","in":"query"},{"name":"orderBillingAddressCountryId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific invoice address country ID.","format":"integer","in":"query"},{"name":"orderDeliveryAddressCountryId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific delivery address country ID.","format":"integer","in":"query"},{"name":"documentNumber_{documentType}","type":"string","required":false,"description":"This filter restricts the search results to orders with a document number with a specific value. The document type has to be replaced in the filter name.","format":"string","in":"query"},{"name":"orderItemProperty_{typeId}","type":"string","required":false,"description":"This filter restricts the search results to orders with an order item property with a specific value. The order property type ID has to be replaced in the filter name.","format":"string","in":"query"},{"name":"addressRelation_{typeId}","type":"integer","required":false,"description":"This filter restricts the search results to orders with an address relation with a specific value. The address relation type ID has to be replaced in the filter name.","format":"integer","in":"query"},{"name":"shippingServiceProviderId","type":"integer","required":false,"description":"This filter restricts the search results to orders with a specific shipping service provider ID.","format":"integer","in":"query"},{"name":"shippingServiceProviderType","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific shipping service provider type.","format":"string","in":"query"},{"name":"shippingStatus","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific shipping status.","format":"string","in":"query"},{"name":"shippingShipmentDate","type":"string","required":false,"description":"This filter restricts the search results to orders with a specific shipment date.","format":"string","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"This field is used for sorting. Default is 'orderId'. Possible values are 'orderId', 'statusId', 'orderDeliveryAddressPostCode', 'invoiceNumber', 'orderDate_{2,3,5,8}', 'orderProperty_33'","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"The order to sort by. Possible values are 'asc' and 'desc'.","format":"string","in":"query"},{"name":"page","type":"integer","required":false,"description":"The page to get. The returned default page 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 displayed per page is 50.","format":"integer","in":"query"},{"name":"with","type":"array","required":false,"description":"Load additional relations for an order.","format":"","in":"query","items":{"type":"string"}},{"name":"lazyLoaded","type":"boolean","required":false,"description":"If true, no default relations are loaded. Default = true.","format":"boolean","in":"query"},{"name":"withDeleted","type":"boolean","required":false,"description":"If true, include deleted orders in result. Default = false.","format":"boolean","in":"query"}]}},"\/rest\/orders\/shipping\/active_shipping_service_providers":{"get":{"summary":"Get the list of active shipping service providers for registration","description":"Get all the active shipping service providers for registration","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":"includePlugins","type":"boolean","required":false,"description":"The flag that indicates if the plugin providers should be also returned in the list","format":"boolean","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":"array","required":false,"description":"The relations to be loaded. Possible values are 'states' and 'names'.","format":"","in":"query","items":{"type":"string"}},{"name":"onlyEUCountries","type":"integer","required":false,"description":"Returns only the EU shipping countries.","format":"integer","in":"query"}]}},"\/rest\/orders\/shipping\/export_documents\/{orderId}":{"get":{"summary":"List export documents","description":"List export documents by order ID.","tags":["Export"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ExportDocument"},"examples":{"application\/json":{"id":9777,"orderId":133488159,"base64Content":"vel","packageNumber":7}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/list_shipping_information":{"get":{"summary":"Return paginated list containing orders with shipping information","description":"Return a paginated list containing all the orders with their shipping information","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":{"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\/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\/{orderShippingPackageId}":{"put":{"summary":"Update an order shipping package by the packageId","description":"Updates an order shipping package. The ID of the order shipping package must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderShippingPackage"},"examples":{"application\/json":{"orderId":313,"packageId":2,"weight":304,"packageNumber":"oEMWjN4wm9","labelPath":"\/path\/to\/label.pdf","packageType":31,"volume":299.18}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"orderShippingPackageId","type":"integer","required":true,"description":"The ID of the order shipping package","format":"integer","in":"path"},{"in":"body","name":"\/rest\/orders\/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"},"extraWeight":{"type":"integer","description":"The extra weight of the package in grams optional"},"itemsWeight":{"type":"integer","description":"The items 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\n 0: unpacked\n 1: Bale\n 2: Dispenser\n 3: Coil\n 4: Roll pallet\n 5: Colli\n 6: Container\n 7: Bucket\n 8: Cask\n 9: Bottles\n 10: European flat pallet\n 11: Structural frame\n 12: Gas cylinder\n 13: Pallet cage\n 14: Hobbock\n 15: Half pallet\n 16: Pallet of food items\n 17: Wooden coaster\n 18: IBC container\n 19: Pitcher\n 20: Wicker bottle\n 21: Case\n 22: Canister\n 23: Customer pallet\n 24: Cardboard box\n 25: Composite packaging\n 26: Package\n 27: Ring\n 28: Role\n 29: Sack\n 30: units\n 31: Tank\n 32: Drum\n 34: Crate\n 35: Quarter pallet\n 36: Other pallets\n 37: Bin\n 38: One-way pallet\n 39: Foil bag\n optional"},"volume":{"type":"number","description":"The volume of the package optional"}}}}]}},"\/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\/packages\/{packageId}\/packed_items":{"get":{"summary":"Get packed items in a package","description":"Get all the packed items from a given package","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 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","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","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","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}\/packages":{"get":{"summary":"Get all the packages for the given pallet ID","description":"Return all the packages linked for the given pallet. The ID of the pallet must be specified","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/OrderShippingPackage"}},"examples":{"application\/json":[{"orderId":165,"packageId":1,"weight":462,"packageNumber":"ON7sujRbiWL","labelPath":"\/path\/to\/label.pdf","packageType":1,"volume":646.97},{"orderId":746,"packageId":7,"weight":718,"packageNumber":"O5fDZAvTe1ys","labelPath":"\/path\/to\/label.pdf","packageType":38,"volume":842.45}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},{"name":"with","type":"array","required":false,"description":"Possible value is 'items'.","format":"","in":"query","items":{"type":"string"}},{"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 packages to list per page.","format":"integer","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"The column to be sorted by","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"The sort direction","format":"string","in":"query"}]}},"\/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"},"examples":{"application\/json":{"shippingRegionId":101,"parcelServicePresetId":16}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The properties to be loaded","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/orders\/shipping\/parcels\/preview\/{language}":{"get":{"summary":"Get preview list","description":"Get a preview list for parcel services.","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":"language","type":"string","required":true,"description":"Language for parcel preset name","format":"string","in":"path"}]}},"\/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"}},"examples":{"application\/json":[{"parcelServiceId":101,"backendName":"k","flag":7,"priority":4,"category":18,"useArticlePorto":1,"isInsured":0,"isExpress":1,"isPostident":1,"isDefaultEnabled":1,"islandFee":78.78,"shippingGroup":"MP295","dispatchIdentifier":"","auctionType":"1","updatedAt":"2015-12-17T07:39:25+01:00","supportedMultishop":["-1"],"supportedReferrer":["2","2.08"],"subreferrerSupport":["-1"],"excludedPaymentMethods":[],"excludedCustomerGroups":[],"supportedLoyaltyPrograms":[]},{"parcelServiceId":1,"backendName":"J","flag":80,"priority":0,"category":1,"useArticlePorto":0,"isInsured":0,"isExpress":1,"isPostident":0,"isDefaultEnabled":0,"islandFee":28.83,"shippingGroup":"MP295","dispatchIdentifier":"","auctionType":"1","updatedAt":"2015-12-17T07:39:25+01:00","supportedMultishop":["-1"],"supportedReferrer":["2","2.08"],"subreferrerSupport":["-1"],"excludedPaymentMethods":[],"excludedCustomerGroups":[],"supportedLoyaltyPrograms":[]}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The attributes to be loaded in the shipping profile","format":"","in":"query","items":{"type":"string"}},{"name":"parcelServiceName","type":"string","required":false,"description":"Filter that restricts the search result to parcel service presets with a specified backend 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":"name","type":"string","required":false,"description":"Filter that restricts the search result to parcel service presets with a specified backend name","format":"string","in":"query"},{"name":"shippingGroup","type":"string","required":false,"description":"Filter that restricts the search result to parcel service preset with specific shipping_group name","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\/preview\/{language}":{"get":{"summary":"Get preview list","description":"Get a preview list for parcel service presets.","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":"language","type":"string","required":true,"description":"Language for parcel preset name","format":"string","in":"path"}]}},"\/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"},"examples":{"application\/json":{"parcelServiceId":101,"backendName":"S","flag":57,"priority":6,"category":19,"useArticlePorto":1,"isInsured":0,"isExpress":0,"isPostident":1,"isDefaultEnabled":0,"islandFee":56.54,"shippingGroup":"MP295","dispatchIdentifier":"","auctionType":"1","updatedAt":"2015-12-17T07:39:25+01:00","supportedMultishop":["-1"],"supportedReferrer":["2","2.08"],"subreferrerSupport":["-1"],"excludedPaymentMethods":[],"excludedCustomerGroups":[],"supportedLoyaltyPrograms":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The attributes to be loaded in the shipping profile","format":"","in":"query","items":{"type":"string"}}]}},"\/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"}},"examples":{"application\/json":[{"shippingRegionId":101,"parcelServicePresetId":17},{"shippingRegionId":101,"parcelServicePresetId":16}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The properties to be loaded","format":"","in":"query","items":{"type":"string"}},{"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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"name":"eum","pluginId":2730494,"createdAt":"1988-02-28T08:01:35+01:00","updatedAt":"2020-06-16T14:04:29+02:00"},{"name":"consequuntur","pluginId":6959651,"createdAt":"1982-04-21T07:46:09+02:00","updatedAt":"1990-01-01T16:19:16+01:00"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 returns service provider","format":"integer","in":"query"},{"name":"name","type":"string","required":true,"description":"The name of the returns service provider","format":"string","in":"query"},{"name":"label","type":"string","required":true,"description":"The label of the returns service provider (if provided by plugin)","format":"string","in":"query"},{"name":"pluginId","type":"integer","required":true,"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"},"examples":{"application\/json":{"name":"amet","pluginId":9040922,"createdAt":"1985-02-03T14:04:31+01:00","updatedAt":"2025-03-11T14:40:19+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}":{"delete":{"summary":"Delete a return order","description":"Delete a return order by i given returns order ID. The returns order ID is mandatory.","tags":["Returns"],"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":"$returnsId","type":"integer","required":true,"description":"Return order ID","format":"integer","in":"query"},{"name":"returnsId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get order returns","description":"Get Order returns specified by the request and the returnsId.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"orderId":753,"returnsOrderId":0,"providerId":74,"createdAt":{"date":"1094-08-11 18:30:27.000000","timezone_type":3,"timezone":"Europe\/Berlin"},"fileName":"Prof. Santos Schaefer PhDpdf","externalNumber":"WWEYFFB58MF","externalData":"{\"fieldOne\":\"Miss Shanna Hirthe\",\"Felix Friesen\":\"schowalter.oda@prosacco.info\"}","availableUntil":{"date":"2025-05-25 09:58:24.000000","timezone_type":3,"timezone":"Europe\/Berlin"}},{"orderId":348,"returnsOrderId":0,"providerId":34,"createdAt":{"date":"0973-12-14 21:31:24.000000","timezone_type":3,"timezone":"Europe\/Berlin"},"fileName":"Elza Kubpdf","externalNumber":"UFZWPEBR262","externalData":"{\"fieldOne\":\"Ms. Rhianna Konopelski Jr.\",\"Chase Halvorson I\":\"lloyd.harber@bernhard.info\"}","availableUntil":{"date":"2025-02-15 20:10:41.000000","timezone_type":3,"timezone":"Europe\/Berlin"}}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"Load additional relations for an order. Currently possible are:\n <ul>\n <li>'documents' = The document objects that are associated with the order returns.<\/li>\n <li>'labels' = The base64 encoded labels that are associated with the order returns.<\/li>\n <\/ul>\n Example: <code>?with[]=documents&with[]=labels<\/code>","format":"","in":"query","items":{"type":"string"}}]},"put":{"summary":"Update a return order","description":"Update return order by a given ID. The return order ID is mandatory.","tags":["Returns"],"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":"$returnsId","type":"integer","required":true,"description":"Return order ID","format":"integer","in":"query"},{"name":"$orderId","type":"integer","required":false,"description":"Order ID for the return order","format":"integer","in":"query"},{"name":"$providerId","type":"integer","required":false,"description":"Return provider ID","format":"integer","in":"query"},{"name":"$externalNumber","type":"string","required":false,"description":"Returns package number","format":"string","in":"query"},{"name":"$base64Label","type":"string","required":false,"description":"Label in base64 format","format":"string","in":"query"},{"name":"returnsId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/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"},"examples":{"application\/json":{"orderId":0,"shippingServiceProvider":"DpdCloudService","transactionId":5,"shippingStatus":"prepared","shippingCosts":8,"additionalData":"Molestiae quis repudiandae veniam odit id eos. Distinctio aut consequatur corrupti facere perferendis. Nihil est itaque nisi voluptatibus.","registrationAt":"2022-01-14T08:41:59+01:00","shipmentAt":"1984-05-11T18:19:56+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"name":"willie.zulauf","pluginId":7864960,"createdAt":"2021-10-03T17:02:05+02:00","updatedAt":"2023-09-03T21:31:39+02:00"},{"name":"laurine.thiel","pluginId":9542357,"createdAt":"2024-10-24T20:55:00+02:00","updatedAt":"2025-07-21T14:35:26+02:00"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"name":"janessa01","pluginId":452128,"createdAt":"1994-03-12T22:23:31+01:00","updatedAt":"2017-05-14T23:19:33+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"name":"runolfsson.shania","pluginId":8529461,"createdAt":"1980-08-05T10:27:22+02:00","updatedAt":"2020-02-04T04:16:22+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"orderId":818,"statusId":1,"createdAt":"2025-09-08T12:07:59+02:00","userId":8,"procedureText":"In illum aut."},{"orderId":531,"statusId":9,"createdAt":"2025-08-26T12:06:17+02:00","userId":5,"procedureText":"Autem at est fuga."}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"number","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"statusId":18.6513,"color":"#75bbda","isFrontendVisible":true,"isReorderVisible":true,"isRedistributionVisible":true,"createdAt":"2025-08-10T12:48:26+02:00","updatedAt":"2025-08-10T12:13:02+02:00"},{"statusId":14.2714,"color":"#fcdea5","isFrontendVisible":false,"isReorderVisible":true,"isRedistributionVisible":false,"createdAt":"2025-08-24T07:28:43+02:00","updatedAt":"2025-08-11T00:46:41+02:00"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"number","in":"query"},{"name":"statusIdTo","type":"number","required":false,"description":"Define an ID as an end value for the filter.","format":"number","in":"query"},{"name":"language","type":"string","required":false,"description":"Filter that restricts the search for order statuses to a defined language.","format":"string","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"},"examples":{"application\/json":{"statusId":6.5283,"color":"#8f277d","isFrontendVisible":true,"isReorderVisible":false,"isRedistributionVisible":true,"createdAt":"2025-08-17T18:55:12+02:00","updatedAt":"2025-09-07T19:35:24+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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":"array","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":"","in":"query","items":{"type":"string"}},{"name":"selectedStatusList","type":"array","required":true,"description":"Set a list with the IDs of the order statuses that should be changed.","format":"","in":"query","items":{"type":"string"}}]}},"\/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":"number","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"},"examples":{"application\/json":{"statusId":6.3388,"color":"#17987f","isFrontendVisible":true,"isReorderVisible":false,"isRedistributionVisible":true,"createdAt":"2025-09-09T03:01:59+02:00","updatedAt":"2025-08-17T20:16:54+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"number","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"},"examples":{"application\/json":{"statusId":5.0367,"color":"#f2605c","isFrontendVisible":true,"isReorderVisible":false,"isRedistributionVisible":false,"createdAt":"2025-08-17T07:18:34+02:00","updatedAt":"2025-08-16T05:48:45+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"number","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"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":8,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"Load additional relations for an order. The following relations are available:\n * <ul>\n <li>'addresses' = The address objects linked to the order.<\/li>\n <li>'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 <li>'comments' = The order comments.<\/li>\n <li>'location' = The accounting location linked to the order.<\/li>\n <li>'payments' = The payments linked to the order.<\/li>\n <li>'documents' = The documents linked to the order.<\/li>\n <li>'contactSender' = The contact belonging the contact-sender relation.<\/li>\n <li>'contactReceiver' = The contact belonging to the contact-receiver relation.<\/li>\n <li>'warehouseSender' = The warehouse belonging to the warehouse-sender relation.<\/li>\n <li>'warehouseReceiver' = The warehouse belonging to the warehouse-receiver relation.<\/li>\n <li>'orderItems.variation' = The variation data belonging to the order item.<\/li>\n <li>'orderItems.variation.propertiesV2' = The properties belonging to the variation.<\/li>\n <li>'orderItems.giftCardCodes' = The gift card codes belonging to the order item.<\/li>\n <li>'orderItems.transactions' = The transactions belonging to the order item.<\/li>\n <li>'orderItems.serialNumbers' = The serial numbers belonging to the order item.<\/li>\n <li>'orderItems.variationBarcodes' = The barcodes belonging to the order item.<\/li>\n <li>'orderItems.comments' = The comments belonging to the order item.<\/li>\n <li>'shippingPallets' = The shipping pallets that are associated with the order.<\/li>\n <li>'shippingPackages' = The shipping packages that are associated with the order.<\/li>\n <li>'paymentTerms' = The payment terms that are associated with the order.<\/li>\n <li><b>deprecated<\/b> 'orderItems.warehouseLocations' = The warehouse locations linked to the order item.<\/li>\n <\/ul>\n Example: <code>?with[]=addresses&with[]=orderItems.variation<\/code>","format":"","in":"query","items":{"type":"string"}},{"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"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":7,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/addresses\/{addressId}\/{relationTypeId}":{"put":{"summary":"Update an address for an existing order.","description":"Updates an address for an existing order and update the relation.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Address"},"examples":{"application\/json":{"gender":"female","name1":"Olson-Bernhard","name2":"Colton","name3":"Kerluke","name4":"stracke.mandy","address1":"Abernathy Land","address2":"3797 Eulah Stravenue","address3":"Knoll","address4":"52749 Stanton Port Suite 329\nPort Alekhaven, PA 52836-4202","postalCode":"73326-6136","town":"Rooseveltchester","countryId":258,"stateId":null,"checkedAt":"2001-10-22T03:20:19+02:00","title":"","contactPerson":"","taxIdNumber":"","options":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"addressId","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"name":"relationTypeId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/orders\/{orderId}\/addresses\/{relationTypeId}":{"get":{"summary":"List order addresses","description":"Lists order addresses. The ID of the order and the ID of the relation type must be specified.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/AddressOrderRelation"},"examples":{"application\/json":{"id":4,"orderId":2,"typeId":6,"addressId":6}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"relationTypeId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"post":{"summary":"Create an address for an existing order.","description":"Creates an address for an existing order and update the relation.","tags":["Account"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Address"},"examples":{"application\/json":{"gender":"diverse","name1":"Considine LLC","name2":"Bartholome","name3":"Wilkinson","name4":"alessia52","address1":"Sandrine Glen","address2":"34181 Smitham Cape","address3":"Shoal","address4":"617 Goyette Plaza\nManleyfort, ND 77274-0441","postalCode":"49395","town":"Spencerview","countryId":183,"stateId":null,"checkedAt":"2004-03-09T13:15:17+01:00","title":"","contactPerson":"","taxIdNumber":"","options":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"relationTypeId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/orders\/{orderId}\/advance_orders":{"post":{"summary":"Create an advance order from a parent order","description":"Creates an advance order from a parent order. The parent order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":2,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/advance_orders","schema":{"type":"object","properties":{"quantities":{"type":"array","items":{}}}}}]}},"\/rest\/orders\/{orderId}\/advance_orders\/convert":{"put":{"summary":"Convert a sales order into an advance order","description":"Converts a sales order into an advance order. The order ID of the sales order must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":2,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/{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"},"examples":{"application\/json":{"text":"Voluptates dolorem illo dolor vitae voluptates doloremque atque aut non omnis blanditiis iste."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"validationType":"plenty","items":[{"amount":1046.71,"noCoupon":0,"quantity":7,"singlePrice":149.53,"itemId":811,"vatField":0}],"contactId":77,"couponCode":"09RJ19","currency":"EUR","referrer":76.1,"salesDiscount":-25,"salesDiscountNet":-21.008403361345,"itemDiscount":-25,"itemDiscountNet":-21.008403361345,"shippingDiscount":0,"shippingDiscountNet":0,"usedVatFields":[-25],"restCouponAmount":0,"checkedItems":{"811":1046.71},"validateParams":{"callFromScheduler":false,"webstoreId":0,"shipToCountry":1,"taxIdNumber":19,"contactClass":8,"contactType":1}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/coupons\/{coupon}\/validate":{"post":{"summary":"Validate coupon for order","description":"Validates a coupon for an order.","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":"","format":"integer","in":"path"},{"name":"coupon","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/orders\/{orderId}\/credit_notes":{"post":{"summary":"Create a credit note from a parent order","description":"Creates a credit note from a parent order. The parent order ID and the quantities to use must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":9,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/credit_notes","schema":{"type":"object","properties":{"statusId":{"type":"number","description":"optional"},"ownerId":{"type":"integer","description":"optional"},"includeCouponsIntoOrderItemPrice":{"type":"boolean","description":"optional"},"quantities":{"type":"array","items":{}}}}}]}},"\/rest\/orders\/{orderId}\/credit_notes\/validate":{"post":{"summary":"Validate order items for create a credit note from a parent order","description":"Validate order items for create a credit note from a parent order. The parent order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/orders\/{orderId}\/currency":{"put":{"summary":"Update the order currency","description":"Updates the order currency. The currency and the exchange rate must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":7,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/{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.\n<b>DEPRECATED: Use the following route: GET \/rest\/orders\/{orderId}<\/b>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/OrderDate"}},"examples":{"application\/json":[{"typeId":5,"date":"2003-08-22T00:56:16+02:00"},{"typeId":2,"date":"1984-12-23T14:12:06+01:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"<b>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<br><ul>\n<li>1 = Deleted on<\/li>\n<li>2 = Created on<\/li>\n<li>3 = Paid date<\/li>\n<li>4 = Last update<\/li>\n<li>5 = Completed on<\/li>\n<li>6 = Return date<\/li>\n<li>7 = Payment due date<\/li>\n<li>8 = Estimated shipping date<\/li>\n<li>9 = Start date<\/li>\n<li>10 = End date<\/li>\n<li>11 = Possible delivery date<\/li>\n<li>12 = Market transfer date<\/li>\n<li>13 = Subscription cancelled on<\/li>\n<li>14 = Subscription last run<\/li>\n<li>15 = Subscription next run<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderDate"},"examples":{"application\/json":{"typeId":6,"date":"1988-02-06T08:11:51+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":2,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/delivery_orders","schema":{"type":"object","properties":{"quantities":{"type":"array","items":{}}}}}]}},"\/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}\/delivery_orders\/validate":{"post":{"summary":"Validate order items for create a delivery order from a parent order","description":"Validate order items for create a delivery order from a parent order. The parent order ID 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":"orderId","type":"integer","required":true,"description":"","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,\n * 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,\n * e.g. '2019-05-29T13:33:23+02:00'","format":"string","in":"query"},{"name":"allowRegenerate","type":"boolean","required":false,"description":"Deprecated. This parameter has no effect anymore.","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,\n * 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\/downloads\/{type}":{"get":{"summary":"Download documents of an order","description":"Downloads documents of an order as a zip file.\nThe ID of the order must be specified. In addition a type can 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":"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 document. The types available are receipt, zReport, tillCount, posCouponReceipt,\n * cancellation, posInvoice, posInvoiceCancellation, invoiceExternal, invoice, deliveryNote,\n * poDeliveryNote, creditNote, creditNoreExternal, orderConfirmation, offer, dunningLetter,\n * reversalDunningLetter, returnNote, successConfirmation, reorder, correction and uploaded.","format":"string","in":"path"}]}},"\/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,\n * 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,\n * e.g. '2019-05-29T13:33:23+02:00'.","format":"string","in":"query"},{"name":"allowRegenerate","type":"boolean","required":false,"description":"Deprecated. This parameter has no effect anymore.","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":"Deprecated. This parameter has no effect anymore.","format":"boolean","in":"query"},{"name":"discount","type":"boolean","required":false,"description":"Deprecated. This parameter has no effect anymore.","format":"boolean","in":"query"},{"name":"discountPercentage","type":"integer","required":false,"description":"Deprecated. This parameter has no effect anymore.","format":"integer","in":"query"},{"name":"discountDays","type":"integer","required":false,"description":"Deprecated. This parameter has no effect anymore.","format":"integer","in":"query"},{"name":"paymentDue","type":"boolean","required":false,"description":"Deprecated. This parameter has no effect anymore.","format":"boolean","in":"query"},{"name":"paymentDueDays","type":"integer","required":false,"description":"Deprecated. This parameter has no effect anymore.","format":"integer","in":"query"}]}},"\/rest\/orders\/{orderId}\/documents\/multi_credit_note\/generate":{"post":{"summary":"Generate multi credit note of an order","description":"Generate multi credit note of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type 'multi 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,\n * 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\/multi_invoice\/generate":{"post":{"summary":"Generate multi-invoice of an order","description":"Generate multi-invoice of an order. The ID of the order must be specified.\nThe document can only be generated for orders of the type '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,\n * 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\/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,\n * 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',\n'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,\n * 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":"Deprecated. This parameter has no effect anymore.","format":"boolean","in":"query"},{"name":"discount","type":"boolean","required":false,"description":"Deprecated. This parameter has no effect anymore.","format":"boolean","in":"query"},{"name":"discountPercentage","type":"integer","required":false,"description":"Deprecated. This parameter has no effect anymore.","format":"integer","in":"query"},{"name":"discountDays","type":"integer","required":false,"description":"Deprecated. This parameter has no effect anymore.","format":"integer","in":"query"},{"name":"paymentDue","type":"boolean","required":false,"description":"Deprecated. This parameter has no effect anymore.","format":"boolean","in":"query"},{"name":"paymentDueDays","type":"integer","required":false,"description":"Deprecated. This parameter has no effect anymore.","format":"integer","in":"query"}]}},"\/rest\/orders\/{orderId}\/documents\/order_custom\/generate":{"post":{"summary":"Generate order custom document of an order","description":"Generate order custom document of an order. The ID of the order 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":"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,\n * 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\/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,\n * 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,\n * 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',\n'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,\n * 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":"Deprecated. This parameter has no effect anymore.","format":"boolean","in":"query"},{"name":"discount","type":"boolean","required":false,"description":"Deprecated. This parameter has no effect anymore.","format":"boolean","in":"query"},{"name":"discountPercentage","type":"integer","required":false,"description":"Deprecated. This parameter has no effect anymore.","format":"integer","in":"query"},{"name":"discountDays","type":"integer","required":false,"description":"Deprecated. This parameter has no effect anymore.","format":"integer","in":"query"},{"name":"paymentDue","type":"boolean","required":false,"description":"Deprecated. This parameter has no effect anymore.","format":"boolean","in":"query"},{"name":"paymentDueDays","type":"integer","required":false,"description":"Deprecated. This parameter has no effect anymore.","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,\n * 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.\n * '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'.\nA 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,\n * 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'.\nA 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,\n * 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,\n * 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',\n'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,\n * 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\/{documentId}\/archive":{"post":{"summary":"Archive document of an order","description":"Archives a 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}":{"get":{"summary":"List documents of an order","description":"Lists documents of an order. The ID of the order must be specified. In addition a type can 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"type":"dunning_letter","number":644533,"numberWithPrefix":"error","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":6,"source":"soap","displayDate":"1972-04-04T20:41:12+01:00","status":"done"},{"type":"reversal_dunning_letter","number":294534795,"numberWithPrefix":"officia","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":11,"source":"paypal","displayDate":"1998-05-07T20:21:25+02:00","status":"done"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"createdAtFrom","type":"string","required":false,"description":"Filter that restricts the search result to documents that were created on the specified date.\n * 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\n * of time. This filter can be used alone or can be combined with the CreatedAtFrom filter.\n * 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.\n * 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\n * of time. This filter can be used alone or can be combined with the UpdatedAtFrom filter.\n * 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.\n * 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\n * period of time. This filter can be used alone or can be combined with the displayDateFrom\n * filter. The date has to be in the W3C format, e.g. '2016-10-24T13:33:23+02:00'.","format":"string","in":"query"},{"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, zReport, tillCount,\n posCouponReceipt, posInvoice, posInvoiceCancellation, cancellation, invoiceExternal, invoice,\n deliveryNote, poDeliveryNote, creditNote, creditNoteExternal, orderConfirmation, offer,\n dunningLetter, reversalDunningLetter, returnNote, successConfirmation, correction, reorder,\n uploaded.","format":"string","in":"path"},{"name":"with","type":"array","required":false,"description":"Load additional relations for a document. Currently possible are:\n <ul>\n <li>'references' = The document reference objects that are associated with the document.<\/li>\n <\/ul>\n Example: <code>?with[]=references<\/code>","format":"","in":"query","items":{"type":"string"}},{"name":"withContent","type":"boolean","required":false,"description":"Load also the document content as base64 encoded string.","format":"boolean","in":"query"}]},"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"}},"examples":{"application\/json":[{"type":"ticket","number":5277408,"numberWithPrefix":"ut","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":8,"source":"admin","displayDate":"1979-04-13T21:15:30+01:00","status":"done"},{"type":"webshop","number":96,"numberWithPrefix":"iste","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":1,"source":"soap","displayDate":"2007-07-31T03:57:33+02:00","status":"done"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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',\n * 'orderConfirmation', 'offer', 'dunningLetter', 'reversalDunningLetter', 'returnNote',\n * 'successConfirmation', 'correction', 'creditNoteExternal', 'reorder', 'uploaded'.","format":"string","in":"path"},{"in":"body","name":"\/rest\/orders\/{orderId}\/documents\/{type}","schema":{"type":"object","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.\nThe 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"},"examples":{"application\/json":{"type":"reorder","number":56724768,"numberWithPrefix":"id","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":11,"source":"admin","displayDate":"1994-05-10T09:14:20+02:00","status":"done"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"type":"reorder","number":7991271,"numberWithPrefix":"aliquam","directoryId":null,"path":"\/some\/path\/on\/the\/server\/document.pdf","userId":7,"source":"admin","displayDate":"1980-08-18T11:59:38+02:00","status":"done"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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,\n * deliveryNote, poDeliveryNote, creditNote, creditNoteExternal, orderConfirmation, offer,\n * dunningLetter, reversalDunningLetter, returnNote, successConfirmation, correction, reversal,\n * 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}\/family":{"get":{"summary":"Get information about the order family","description":"Gets information about the order family. All related orders can be shown as tree when the parameter 'with' is given with the value 'tree'.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderFamily"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/{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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"orderId":1,"typeId":9,"referrerId":172,"itemVariationId":99089,"quantity":9,"countryVatId":2,"vatField":2,"vatRate":0,"orderItemName":"Ut hic fugit consequatur","attributeValues":"tempora sed","shippingProfileId":5,"createdAt":"2012-12-23T19:59:47+01:00","updatedAt":"2015-11-01T07:35:55+01:00"},{"orderId":1,"typeId":3,"referrerId":160.1,"itemVariationId":1012,"quantity":6,"countryVatId":1,"vatField":1,"vatRate":7,"orderItemName":"Repellat id aliquid laudantium","attributeValues":"rerum tempore","shippingProfileId":8,"createdAt":"2020-06-21T05:45:27+02:00","updatedAt":"2005-08-28T17:00:16+02:00"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"Load additional relations for an order item. Currently possible are:\n <ul>\n <li>'variation' = The variation that is associated with the order item.<\/li>\n <li>'giftCardCodes' = The gift card codes that are associated with the order item.<\/li>\n <li>'transactions' = The transactions that are associated with the order item.<\/li>\n <li>'serialNumbers' = The serial numbers that are associated with the order item.<\/li>\n <li>'variationBarcodes' = The barcodes that are associated with variation of the order item.<\/li>\n <\/ul>","format":"","in":"query","items":{"type":"string"}},{"name":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/orders\/{orderId}\/items\/reorders\/generate":{"post":{"summary":"Create \/ update reorder(s) for order items","description":"Creates or updates reorders for given order items.","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":"","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"}},"examples":{"application\/json":[{"orderId":129,"orderItemId":386,"serialNumberId":677,"serialNumber":null,"itemSerialNumber":null},{"orderId":773,"orderItemId":988,"serialNumberId":208,"serialNumber":null,"itemSerialNumber":null}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/warehouse_locations\/attach":{"post":{"summary":"Attach warehouse locations.","description":"Attach warehouse locations. 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"}]}},"\/rest\/orders\/{orderId}\/items\/warehouse_locations\/detach":{"post":{"summary":"Detach warehouse locations.","description":"Detach warehouse locations. 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"}]}},"\/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"}},"examples":{"application\/json":[{"orderId":694,"orderItemId":978,"serialNumberId":655,"serialNumber":null,"itemSerialNumber":null},{"orderId":535,"orderItemId":797,"serialNumberId":677,"serialNumber":null,"itemSerialNumber":null}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]},"post":{"summary":"Create item serial number and bind it to order item","description":"Creates item serial number and bind it to 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":{"$ref":"#\/definitions\/OrderSerialNumber"},"examples":{"application\/json":{"orderId":720,"orderItemId":489,"serialNumberId":468,"serialNumber":null,"itemSerialNumber":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"orderItemId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/orders\/{orderId}\/my_account_url":{"get":{"summary":"Get My Account url of the order","description":"Gets the My Account url of the order","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":"","format":"integer","in":"path"}]}},"\/rest\/orders\/{orderId}\/offers":{"post":{"summary":"Create an offer from a parent order","description":"Creates an offer from a parent order. The parent order ID and the quantities to use must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":4,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/offers","schema":{"type":"object","properties":{"quantities":{"type":"array","items":{}}}}}]}},"\/rest\/orders\/{orderId}\/outgoing_stocks":{"delete":{"summary":"Revert outgoing stock","description":"<b>DEPRECATED: Use the following route: POST \/rest\/{orderType}\/{orderId}\/cancel_booking<\/b>\nCancellation the booking 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":"<b>DEPRECATED: Use the following route: POST \/rest\/{orderType}\/{orderId}\/book<\/b>\nBooks 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"}},"examples":{"application\/json":["J92356732176","003478943219912"]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"<b>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"},"examples":{"application\/json":{"orderId":103,"typeId":10,"value":"soluta","createdAt":"2025-02-25T05:20:36+01:00","updatedAt":"2025-08-11T13:43:01+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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 = 1\n* SHIPPING_PROFILE = 2\n* PAYMENT_METHOD = 3\n* PAYMENT_STATUS = 4\n* EXTERNAL_SHIPPING_PROFILE = 5\n* DOCUMENT_LANGUAGE = 6\n* EXTERNAL_ORDER_ID = 7\n* CUSTOMER_SIGN = 8\n* DUNNING_LEVEL = 9\n* SELLER_ACCOUNT = 10\n* WEIGHT = 11\n* WIDTH = 12\n* LENGTH = 13\n* HEIGHT = 14\n* FLAG = 15\n* EXTERNAL_TOKEN_ID = 16\n* EXTERNAL_ITEM_ID = 17\n* COUPON_CODE = 18\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* MARKET_TAX_ID = 88\n* MARKET_EORI = 89\n* IS_REVERSE_CHARGED = 90\n* DISALLOW_INTERNAL_TAX_RELEVANT_DOCUMENTS = 91\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":"<b>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<br><ul>\n<li>1 = WAREHOUSE<\/li>\n<li>2 = SHIPPING_PROFILE<\/li>\n<li>3 = PAYMENT_METHOD<\/li>\n<li>4 = PAYMENT_STATUS<\/li>\n<li>5 = EXTERNAL_SHIPPING_PROFILE<\/li>\n<li>6 = DOCUMENT_LANGUAGE<\/li>\n<li>7 = EXTERNAL_ORDER_ID<\/li>\n<li>8 = CUSTOMER_SIGN<\/li>\n<li>9 = DUNNING_LEVEL<\/li>\n<li>10 = SELLER_ACCOUNT<\/li>\n<li>11 = WEIGHT<\/li>\n<li>12 = WIDTH<\/li>\n<li>13 = LENGTH<\/li>\n<li>14 = HEIGHT<\/li>\n<li>15 = FLAG<\/li>\n<li>16 = EXTERNAL_TOKEN_ID<\/li>\n<li>17 = EXTERNAL_ITEM_ID<\/li>\n<li>18 = COUPON_CODE<\/li>\n<li>19 = COUPON_TYPE<\/li>\n<li>33 = MAIN_DOCUMENT_NUMBER<\/li>\n<li>34 = SALES_TAX_ID_NUMBER<\/li>\n<li>45 = PAYMENT_TRANSACTION_ID<\/li>\n<li>47 = EXTERNAL_TAX_SERVICE<\/li>\n<li>60 = MERCHANT_ID<\/li>\n<li>61 = REPORT_ID<\/li>\n<li>63 = PREFERRED_STORAGE_LOCATION_ID<\/li>\n<li>64 = AMAZON_SHIPPING_LABEL<\/li>\n<li>994 = EBAY_PLUS<\/li>\n<li>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","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 = 1\n* SHIPPING_PROFILE = 2\n* PAYMENT_METHOD = 3\n* PAYMENT_STATUS = 4\n* EXTERNAL_SHIPPING_PROFILE = 5\n* DOCUMENT_LANGUAGE = 6\n* EXTERNAL_ORDER_ID = 7\n* CUSTOMER_SIGN = 8\n* DUNNING_LEVEL = 9\n* SELLER_ACCOUNT = 10\n* WEIGHT = 11\n* WIDTH = 12\n* LENGTH = 13\n* HEIGHT = 14\n* FLAG = 15\n* EXTERNAL_TOKEN_ID = 16\n* EXTERNAL_ITEM_ID = 17\n* COUPON_CODE = 18\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* MARKET_TAX_ID = 88\n* MARKET_EORI = 89\n* IS_REVERSE_CHARGED = 90\n* DISALLOW_INTERNAL_TAX_RELEVANT_DOCUMENTS = 91\n* EBAY_PLUS = 994\n* FULFILLMENT_SERVICE = 995"}}}}]},"get":{"summary":"List properties of an order","description":"<b>DEPRECATED: Use the following route: GET \/rest\/orders\/{orderId}<\/b>\nLists properties of an order. The ID of the order must be specified. Optionally, the ID of the property type can be specified. The following property types are available by default:\n\n<br><ul>\n<li>1 = WAREHOUSE<\/li>\n<li>2 = SHIPPING_PROFILE<\/li>\n<li>3 = PAYMENT_METHOD<\/li>\n<li>4 = PAYMENT_STATUS<\/li>\n<li>5 = EXTERNAL_SHIPPING_PROFILE<\/li>\n<li>6 = DOCUMENT_LANGUAGE<\/li>\n<li>7 = EXTERNAL_ORDER_ID<\/li>\n<li>8 = CUSTOMER_SIGN<\/li>\n<li>9 = DUNNING_LEVEL<\/li>\n<li>10 = SELLER_ACCOUNT<\/li>\n<li>11 = WEIGHT<\/li>\n<li>12 = WIDTH<\/li>\n<li>13 = LENGTH<\/li>\n<li>14 = HEIGHT<\/li>\n<li>15 = FLAG<\/li>\n<li>16 = EXTERNAL_TOKEN_ID<\/li>\n<li>17 = EXTERNAL_ITEM_ID<\/li>\n<li>18 = COUPON_CODE<\/li>\n<li>19 = COUPON_TYPE<\/li>\n<li>33 = MAIN_DOCUMENT_NUMBER<\/li>\n<li>34 = SALES_TAX_ID_NUMBER<\/li>\n<li>45 = PAYMENT_TRANSACTION_ID<\/li>\n<li>47 = EXTERNAL_TAX_SERVICE<\/li>\n<li>60 = MERCHANT_ID<\/li>\n<li>61 = REPORT_ID<\/li>\n<li>63 = PREFERRED_STORAGE_LOCATION_ID<\/li>\n<li>64 = AMAZON_SHIPPING_LABEL<\/li>\n<li>994 = EBAY_PLUS<\/li>\n<li>995 = FULFILLMENT_SERVICE<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/OrderProperty"}},"examples":{"application\/json":[{"orderId":103,"typeId":7,"value":"ut","createdAt":"2025-02-02T17:51:49+01:00","updatedAt":"2025-06-20T02:57:35+02:00"},{"orderId":103,"typeId":15,"value":"officia","createdAt":"2025-06-06T15:02:09+02:00","updatedAt":"2025-05-30T06:26:39+02:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"typeId","type":"integer","required":true,"description":"The property type ID","format":"integer","in":"path"}]},"put":{"summary":"Update property of an order by order ID and property ID","description":"<b>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<br><ul>\n<li>1 = WAREHOUSE<\/li>\n<li>2 = SHIPPING_PROFILE<\/li>\n<li>3 = PAYMENT_METHOD<\/li>\n<li>4 = PAYMENT_STATUS<\/li>\n<li>5 = EXTERNAL_SHIPPING_PROFILE<\/li>\n<li>6 = DOCUMENT_LANGUAGE<\/li>\n<li>7 = EXTERNAL_ORDER_ID<\/li>\n<li>8 = CUSTOMER_SIGN<\/li>\n<li>9 = DUNNING_LEVEL<\/li>\n<li>10 = SELLER_ACCOUNT<\/li>\n<li>11 = WEIGHT<\/li>\n<li>12 = WIDTH<\/li>\n<li>13 = LENGTH<\/li>\n<li>14 = HEIGHT<\/li>\n<li>15 = FLAG<\/li>\n<li>16 = EXTERNAL_TOKEN_ID<\/li>\n<li>17 = EXTERNAL_ITEM_ID<\/li>\n<li>18 = COUPON_CODE<\/li>\n<li>19 = COUPON_TYPE<\/li>\n<li>33 = MAIN_DOCUMENT_NUMBER<\/li>\n<li>34 = SALES_TAX_ID_NUMBER<\/li>\n<li>45 = PAYMENT_TRANSACTION_ID<\/li>\n<li>47 = EXTERNAL_TAX_SERVICE<\/li>\n<li>60 = MERCHANT_ID<\/li>\n<li>61 = REPORT_ID<\/li>\n<li>63 = PREFERRED_STORAGE_LOCATION_ID<\/li>\n<li>64 = AMAZON_SHIPPING_LABEL<\/li>\n<li>994 = EBAY_PLUS<\/li>\n<li>995 = FULFILLMENT_SERVICE<\/li>\n<\/ul>","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderProperty"},"examples":{"application\/json":{"orderId":103,"typeId":16,"value":"ullam","createdAt":"2025-06-23T03:00:55+02:00","updatedAt":"2025-05-27T13:06:06+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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 = 1\n* SHIPPING_PROFILE = 2\n* PAYMENT_METHOD = 3\n* PAYMENT_STATUS = 4\n* EXTERNAL_SHIPPING_PROFILE = 5\n* DOCUMENT_LANGUAGE = 6\n* EXTERNAL_ORDER_ID = 7\n* CUSTOMER_SIGN = 8\n* DUNNING_LEVEL = 9\n* SELLER_ACCOUNT = 10\n* WEIGHT = 11\n* WIDTH = 12\n* LENGTH = 13\n* HEIGHT = 14\n* FLAG = 15\n* EXTERNAL_TOKEN_ID = 16\n* EXTERNAL_ITEM_ID = 17\n* COUPON_CODE = 18\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* MARKET_TAX_ID = 88\n* MARKET_EORI = 89\n* IS_REVERSE_CHARGED = 90\n* DISALLOW_INTERNAL_TAX_RELEVANT_DOCUMENTS = 91\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}\/redistributions":{"post":{"summary":"Create a redistribution from a parent order","description":"Creates a redistribution from a parent order. The parent order ID and the quantities to use must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":3,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/{orderId}\/reorders":{"post":{"summary":"Create a reorder from a parent order","description":"Creates a reorder from a parent order. The parent order ID and the quantities to use must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":3,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/{orderId}\/reorders\/generate":{"post":{"summary":"Create reorder(s) for an order","description":"Creates reorders for a given order.","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":"","format":"integer","in":"path"}]}},"\/rest\/orders\/{orderId}\/reorders\/generate\/validate":{"post":{"summary":"Validate order items for create a reorder from a sales order, delivery order, repair and warranty","description":"Validate order items for create a reorder from a sales order, delivery order, repair and warranty. The parent order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/orders\/{orderId}\/repairs":{"post":{"summary":"Create a repair order from a parent order","description":"Creates a repair order from a parent order. The parent order ID and the quantities to use must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":6,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/repairs","schema":{"type":"object","properties":{"statusId":{"type":"number","description":"optional"},"ownerId":{"type":"integer","description":"optional"},"repairStatusId":{"type":"integer","description":"optional"},"quantities":{"type":"array","items":{}}}}}]}},"\/rest\/orders\/{orderId}\/repairs\/validate":{"post":{"summary":"Validate order items for create a repair from a parent order","description":"Validate order items for create a repair from a parent order. The parent order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/orders\/{orderId}\/returns":{"post":{"summary":"Create a return from a parent order","description":"Creates a return from a parent order. The parent order ID and the quantities to use must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":6,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/returns","schema":{"type":"object","properties":{"includeCouponsIntoOrderItemPrice":{"type":"boolean","description":"optional"},"statusId":{"type":"number","description":"optional"},"ownerId":{"type":"integer","description":"optional"},"returnPackageNumber":{"type":"string","description":"optional"},"warehouseId":{"type":"integer","description":"optional"},"quantities":{"type":"array","items":{}}}}}]}},"\/rest\/orders\/{orderId}\/returns\/validate":{"post":{"summary":"Validate order items for create a return from a parent order","description":"Validate order items for create a return from a parent order. The parent order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/orders\/{orderId}\/sales_orders":{"post":{"summary":"Create a sales order from a parent order","description":"Creates a sales order from a parent order. The parent order ID and the quantities to use must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":4,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/sales_orders","schema":{"type":"object","properties":{"statusId":{"type":"number","description":"optional"},"quantities":{"type":"array","items":{}}}}}]}},"\/rest\/orders\/{orderId}\/sales_orders\/convert":{"put":{"summary":"Convert an advance order into a sales order","description":"Converts an advance order into a sales order. The order ID of the advance order must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":9,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/{orderId}\/sales_orders\/validate":{"post":{"summary":"Validate order items for create a sales order from a parent order","description":"Validate order items for create a sales order from a parent order. The parent order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/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"}},"examples":{"application\/json":[{"orderId":767,"packageId":6,"weight":490,"packageNumber":"8v4fnE06cki","labelPath":"\/path\/to\/label.pdf","packageType":4,"volume":145.97},{"orderId":765,"packageId":7,"weight":348,"packageNumber":"sA3CKVIMn","labelPath":"\/path\/to\/label.pdf","packageType":19,"volume":431.41}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The properties to be loaded","format":"","in":"query","items":{"type":"string"}},{"name":"with","type":"string","required":false,"description":"Possible values are 'labelBase64', 'items'","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"},"examples":{"application\/json":{"orderId":457,"packageId":3,"weight":891,"packageNumber":"ZThkgu7KBP","labelPath":"\/path\/to\/label.pdf","packageType":24,"volume":696.76}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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\n 0: unpacked\n 1: Bale\n 2: Dispenser\n 3: Coil\n 4: Roll pallet\n 5: Colli\n 6: Container\n 7: Bucket\n 8: Cask\n 9: Bottles\n 10: European flat pallet\n 11: Structural frame\n 12: Gas cylinder\n 13: Pallet cage\n 14: Hobbock\n 15: Half pallet\n 16: Pallet of food items\n 17: Wooden coaster\n 18: IBC container\n 19: Pitcher\n 20: Wicker bottle\n 21: Case\n 22: Canister\n 23: Customer pallet\n 24: Cardboard box\n 25: Composite packaging\n 26: Package\n 27: Ring\n 28: Role\n 29: Sack\n 30: units\n 31: Tank\n 32: Drum\n 34: Crate\n 35: Quarter pallet\n 36: Other pallets\n 37: Bin\n 38: One-way pallet\n 39: Foil bag"},"volume":{"type":"number","description":"The volume of the package optional"},"labelPath":{"type":"string","description":"The path to the label optional"},"returnPackageNumber":{"type":"string","description":"The return package number 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\/unpacked_items_paginated":{"get":{"summary":"List unpacked items from an order","description":"Lists unpacked items from a specific order ID. 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\/{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"},"examples":{"application\/json":{"orderId":649,"packageId":9,"weight":573,"packageNumber":"dQAeCTcWtKKc","labelPath":"\/path\/to\/label.pdf","packageType":9,"volume":436.12}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The properties to be loaded","format":"","in":"query","items":{"type":"string"}}]},"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"},"examples":{"application\/json":{"orderId":299,"packageId":7,"weight":354,"packageNumber":"P9IVSLIHA4kV","labelPath":"\/path\/to\/label.pdf","packageType":0,"volume":574.57}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"extraWeight":{"type":"integer","description":"The extra weight of the package in grams optional"},"itemsWeight":{"type":"integer","description":"The items 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\n 0: unpacked\n 1: Bale\n 2: Dispenser\n 3: Coil\n 4: Roll pallet\n 5: Colli\n 6: Container\n 7: Bucket\n 8: Cask\n 9: Bottles\n 10: European flat pallet\n 11: Structural frame\n 12: Gas cylinder\n 13: Pallet cage\n 14: Hobbock\n 15: Half pallet\n 16: Pallet of food items\n 17: Wooden coaster\n 18: IBC container\n 19: Pitcher\n 20: Wicker bottle\n 21: Case\n 22: Canister\n 23: Customer pallet\n 24: Cardboard box\n 25: Composite packaging\n 26: Package\n 27: Ring\n 28: Role\n 29: Sack\n 30: units\n 31: Tank\n 32: Drum\n 34: Crate\n 35: Quarter pallet\n 36: Other pallets\n 37: Bin\n 38: One-way pallet\n 39: Foil bag\n optional"},"volume":{"type":"number","description":"The volume of the package optional"}}}}]}},"\/rest\/orders\/{orderId}\/shipping\/packages_paginated":{"get":{"summary":"Get all the packages for the given order","description":"Return all the packages linked for the given order. The ID of the order must be specified","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/OrderShippingPackage"}},"examples":{"application\/json":[{"orderId":883,"packageId":5,"weight":593,"packageNumber":"wJGX1MwH","labelPath":"\/path\/to\/label.pdf","packageType":30,"volume":822.73},{"orderId":703,"packageId":3,"weight":178,"packageNumber":"6BMk04mxq1AD","labelPath":"\/path\/to\/label.pdf","packageType":6,"volume":219.22}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"Possible value is 'items'.","format":"","in":"query","items":{"type":"string"}},{"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 packages to list per page.","format":"integer","in":"query"},{"name":"sortBy","type":"string","required":false,"description":"The column to be sorted by","format":"string","in":"query"},{"name":"sortOrder","type":"string","required":false,"description":"The sort direction","format":"string","in":"query"}]}},"\/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"}},"examples":{"application\/json":[{"orderId":170,"packageId":4,"weight":964,"packageNumber":"K28zEerGo","labelPath":"\/path\/to\/label.pdf","packageType":1,"volume":484.42},{"orderId":246,"packageId":7,"weight":367,"packageNumber":"4q9T87Ce1X","labelPath":"\/path\/to\/label.pdf","packageType":32,"volume":812.48}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},{"name":"shippingProviderCode","type":"string","required":false,"description":"The code of the shipping service provider","format":"string","in":"query"}]}},"\/rest\/orders\/{orderId}\/shipping\/reset_shipment":{"delete":{"summary":"Reset a shipment","description":"Reset 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":"Get order returns","description":"Get Order returns specified by the request and the orderId.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"orderId":98,"returnsOrderId":0,"providerId":34,"createdAt":{"date":"1191-02-22 08:42:17.000000","timezone_type":3,"timezone":"Europe\/Berlin"},"fileName":"Prof. Shanelle Paucek IIIpdf","externalNumber":"BEZGRZLHJYH","externalData":"{\"fieldOne\":\"Prof. Mariela Jacobs\",\"Mr. Jo Hudson IV\":\"towne.lia@walsh.com\"}","availableUntil":{"date":"2025-09-09 15:18:32.000000","timezone_type":3,"timezone":"Europe\/Berlin"}},{"orderId":376,"returnsOrderId":0,"providerId":58,"createdAt":{"date":"1731-09-19 16:15:01.000000","timezone_type":3,"timezone":"Europe\/Berlin"},"fileName":"Queen Lowepdf","externalNumber":"HNJPOM69WY4","externalData":"{\"fieldOne\":\"Santina Lindgren MD\",\"Guy Mayer\":\"wolf.tavares@hagenes.com\"}","availableUntil":{"date":"2025-03-25 21:41:01.000000","timezone_type":3,"timezone":"Europe\/Berlin"}}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"orderType","type":"string","required":false,"description":"The order type to search for delivery or return orders","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 orders to be displayed per page. The default number of orders per page is 50.","format":"integer","in":"query"},{"name":"with","type":"array","required":false,"description":"Load additional relations for an order. Currently possible are:\n <ul>\n <li>'documents' = The document objects that are associated with the order returns.<\/li>\n <li>'labels' = The base64 encoded labels that are associated with the order returns.<\/li>\n <\/ul>\n Example: <code>?with[]=documents&with[]=labels<\/code>","format":"","in":"query","items":{"type":"string"}}]},"post":{"summary":"Create a return order","description":"Add return order to an orderId","tags":["Returns"],"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":"$orderId","type":"integer","required":true,"description":"Order ID","format":"integer","in":"query"},{"name":"$providerId","type":"integer","required":true,"description":"Return provider ID","format":"integer","in":"query"},{"name":"$externalNumber","type":"string","required":true,"description":"Returns package number","format":"string","in":"query"},{"name":"$base64Label","type":"string","required":false,"description":"Label in base64 format","format":"string","in":"query"},{"name":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/orders\/{orderId}\/shipping\/returns\/assign_label\/{returnsId}":{"put":{"summary":"Assign label to order return","description":"Assign a label to order return specified by the orderId and the returnsId.","tags":["Returns"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/OrderReturns"},"examples":{"application\/json":{"orderId":425,"returnsOrderId":0,"providerId":76,"createdAt":{"date":"0007-09-13 20:19:56.000000","timezone_type":3,"timezone":"Europe\/Berlin"},"fileName":"Amira Kubpdf","externalNumber":"AINVCAMG","externalData":"{\"fieldOne\":\"Miss Dovie Ullrich IV\",\"Neil Baumbach\":\"hayes.eula@oconner.com\"}","availableUntil":{"date":"2025-05-14 08:46:34.000000","timezone_type":3,"timezone":"Europe\/Berlin"}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"orderId":3,"shippingServiceProvider":"DpdCloudService","transactionId":2,"shippingStatus":"registered","shippingCosts":4,"additionalData":"Tenetur natus et deleniti ut quia omnis. Quod deserunt aut eaque expedita. Aut explicabo explicabo id aut vel. Voluptates enim mollitia velit.","registrationAt":"1977-03-07T20:43:25+01:00","shipmentAt":"2002-11-12T00:23:28+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"orderId":6,"shippingServiceProvider":"DpdCloudService","transactionId":5,"shippingStatus":"registered","shippingCosts":2,"additionalData":"Doloribus veniam minima enim dolores voluptates aliquam autem. Dolores eaque alias numquam sed enim ipsam ut. Accusamus magni voluptate et quo.","registrationAt":"1990-09-06T07:57:30+02:00","shipmentAt":"2016-10-19T08:39:31+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"orderId":8,"shippingServiceProvider":"DpdCloudService","transactionId":3,"shippingStatus":"registered","shippingCosts":2,"additionalData":"Est iusto eligendi est numquam et. Numquam corporis in dolorem illo temporibus quasi. Ab sed qui est reiciendis. Consequatur non doloribus doloremque qui et ullam sed.","registrationAt":"1994-06-12T21:42:08+02:00","shipmentAt":"2015-03-05T13:35:53+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/export_label":{"get":{"summary":"Get Export label","description":"Get Export label for an order ID.","tags":["Order"],"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":"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"},"examples":{"application\/json":{"orderId":3,"shippingServiceProvider":"DpdCloudService","transactionId":5,"shippingStatus":"prepared","shippingCosts":2,"additionalData":"Voluptatem ut fuga molestias cum. Tenetur quod laborum voluptates debitis. Adipisci magni cupiditate dolorem eaque.","registrationAt":"1993-06-18T23:45:43+02:00","shipmentAt":"2000-08-03T20:54:36+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"orderId":417,"statusId":4,"createdAt":"2025-08-25T06:53:03+02:00","userId":1,"procedureText":"Ipsam nihil suscipit quia sit mollitia."},{"orderId":782,"statusId":4,"createdAt":"2025-08-12T13:15:19+02:00","userId":7,"procedureText":"Corrupti cumque repellat cum."}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/subscriptions":{"post":{"summary":"Create a subscription from a parent order","description":"Creates a subscription from a parent order. The parent order ID and the quantities to use must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":3,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/subscriptions","schema":{"type":"object","properties":{"statusId":{"type":"number","description":"optional"},"ownerId":{"type":"integer","description":"optional"},"intervalType":{"type":"string","description":"optional allowed values are day, week, month, year"},"intervalValue":{"type":"integer","description":"optional"},"startDate":{"type":"string","description":"optional"},"endDate":{"type":"string","description":"optional"},"quantities":{"type":"array","items":{}}}}}]}},"\/rest\/orders\/{orderId}\/subscriptions\/validate":{"post":{"summary":"Validate order items for subscription creation from a parent order","description":"Validate order items for subscription creation from a parent order. The parent order ID 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":"orderId","type":"integer","required":true,"description":"","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"}},"examples":{"application\/json":[{"orderItemId":233,"quantity":9.08,"userId":90,"identification":"aut","direction":"out","status":"cancelled","warehouseLocationId":117,"batch":"velit","bestBeforeDate":"1986-07-01","createdAt":"2025-08-20T03:47:17+02:00","updatedAt":"2025-08-14T22:31:07+02:00","deliveryNoteNumber":"possimus"},{"orderItemId":585,"quantity":50.05,"userId":38,"identification":"architecto","direction":"out","status":"cancelled","warehouseLocationId":638,"batch":"incidunt","bestBeforeDate":"1978-06-30","createdAt":"2025-08-20T18:22:37+02:00","updatedAt":"2025-08-17T10:49:38+02:00","deliveryNoteNumber":"reiciendis"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"deliveryNoteNumber":{"type":"string","description":"The delivery note number"}}}}]}},"\/rest\/orders\/{orderId}\/warranties":{"post":{"summary":"Create a warranty from a parent order","description":"Creates a warranty from a parent order. The parent order ID and the quantities to use must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":1,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}\/warranties","schema":{"type":"object","properties":{"statusId":{"type":"number","description":"optional"},"ownerId":{"type":"integer","description":"optional"},"quantities":{"type":"array","items":{}}}}}]}},"\/rest\/orders\/{orderId}\/warranties\/validate":{"post":{"summary":"Validate order items for create a warranty from a parent order","description":"Validate order items for create a warranty from a parent order. The parent order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/payment\/properties\/types\/names":{"post":{"summary":"Create name of property type","description":"Create a name of a property type","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","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 name of property type","description":"Update a name of a property type","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","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\/{lang}":{"get":{"summary":"List names of property types","description":"List names of property types in the specified language or German if none is 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":"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":"lang","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/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":"Delete a Payment-Contact-Relation specified by a paymentId.","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":"Creates a Payment-Contact-Relation specified by a paymentId and contactId.","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":"Deletes a Payment-Order-Relation specified by a paymentId.","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\/{invoiceNumber}\/invoice":{"post":{"summary":"Create order relation with validation","description":"Create a new order relation with validation by orderId and paymentId.","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":"invoiceNumber","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/payment\/{paymentId}\/order\/{orderId}":{"post":{"summary":"Create Payment-Order-Relation","description":"Creates a Payment-Order-Relation specified by paymentId and orderId.","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\/payment\/{paymentId}\/order\/{orderId}\/validation":{"post":{"summary":"Create order relation with validation","description":"Create a new order relation with validation by orderId and paymentId.","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":"Get an array of all available payments in the PaymentRepository","tags":["Payment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/Payment"}},"examples":{"application\/json":[{"hash":"T7)Wyk=Ovjz8,c;(J","importedAt":"2021-12-03T06:59:00+01:00"},{"hash":"xf6)+&[Xw","importedAt":"2021-12-03T06:59:00+01:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"Create a payment specified by the request.","tags":["Payment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Payment"},"examples":{"application\/json":{"hash":"!A%-B\\~NdD","importedAt":"2021-12-03T06:59:00+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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":"Update the payment specifed in the request.","tags":["Payment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Payment"},"examples":{"application\/json":{"hash":"SzUmQg,sc","importedAt":"2021-12-03T06:59:00+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","properties":{"id":{"type":"integer","description":"The ID of the payment"},"amount":{"type":"number","description":"The amount of the payment optional"},"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. optional"},"parentId":{"type":"integer","description":"The ID of the parent payment optional"},"deleted":{"type":"integer","description":"A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. optional"},"unaccountable":{"type":"integer","description":"An unassigned payment. Unassigned payments have the value 1. optional"},"currency":{"type":"string","description":"The currency of the payment in ISO 4217 code. optional matching to \/^[A-Z]{3}$\/"},"type":{"type":"string","description":"The payment type. Available types are credit and debit. optional allowed values are debit, credit"},"hash":{"type":"string","description":"The hash code of the payment. The hash code consists of 32 characters and is automatically generated. optional"},"origin":{"type":"integer","description":"The origin of the payment. The following origins are available:\n\n Undefined = 0\n System = 1\n Manually = 2\n SOAP = 3\n Import = 4\n Split payment = 5\n Plugin = 6\n POS = 7\n optional allowed values are 0, 1, 2, 3, 4, 5, 6, 7"},"receivedAt":{"type":"string","description":"The time the payment was received optional"},"importedAt":{"type":"string","description":"The time the payment was imported optional"},"status":{"type":"integer","description":"The status of the payment optional allowed values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11"},"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 optional allowed values are 1, 2, 3, 4"},"mopId":{"type":"integer","description":"The ID of the payment method optional"},"histories":{"type":"array","items":{"$ref":"#\/definitions\/PaymentHistory"}},"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 rate = 36"},"value":{"type":"string","description":"The value of the property type optional"},"user":{"type":"string","description":"The user who initiated the action optional"},"properties":{"type":"array","items":{"$ref":"#\/definitions\/PaymentProperty"}},"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"},"isSystemCurrency":{"type":"boolean","description":"If $isSystemCurrency is false, the value will be converted to the standard currency with the provided exchange rate. If $isSystemCurrency is true, the value is not converted. Default is true. optional"}}}}]}},"\/rest\/payments\/bulk":{"delete":{"summary":"Delete payents","description":"Bulk delete payments specified by their ids.","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":"ids","type":"array","required":false,"description":"An array with payment ids to be deleted. Eg: ['ids' => [1,2,3]]","format":"","in":"query","items":{"type":"integer"}}]}},"\/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"}},"examples":{"application\/json":[{"hash":"g2nP2|:S0VJ","importedAt":"2021-12-03T06:59:00+01:00"},{"hash":"x2d;>-)]9m`e>","importedAt":"2021-12-03T06:59:00+01:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"hash":"<4Tv{dl_auS7;|mkF<","importedAt":"2021-12-03T06:59:00+01:00"},{"hash":"Jlxwv}I0eZ>w)0wgN?z","importedAt":"2021-12-03T06:59:00+01:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"pluginKey":"plenty","paymentKey":"fred.schmidt","name":"sydni.krajcik"},{"pluginKey":"plenty","paymentKey":"shanelle65","name":"istehr"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"backendSearchable","type":"boolean","required":false,"description":"Receive only payment methods that are searchable for the backend.","format":"boolean","in":"query"},{"name":"backendActive","type":"boolean","required":false,"description":"Receive only payment methods that are active for the backend.","format":"boolean","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"},"examples":{"application\/json":{"pluginKey":"plenty","paymentKey":"jlang","name":"frances.johnson"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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 and isDocumentBuilderActive of the payment method.","tags":["Payment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PaymentMethod"},"examples":{"application\/json":{"pluginKey":"plenty","paymentKey":"javier90","name":"janick06"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","properties":{"id":{"type":"integer","description":"The ID of the payment method"},"name":{"type":"string","description":"The name of the payment method optional"},"isDocumentBuilderActive":{"type":"boolean","description":"Flag that indicates if payment method is checked for document builder optional"}}}}]}},"\/rest\/payments\/methods\/bulk":{"put":{"summary":"Updates payment methods","description":"Updates multiple payment methods by id","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":{"get":{"summary":"Get payment methods","description":"Returns all payment methods with id and name","tags":["Payment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":{"6000":"Cash In Advance","6005":"Debit"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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":"Get active payment methods","description":"Returns all payment methods with id and name which are active for the backend","tags":["Payment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":{"6000":"Cash In Advance","6005":"Debit"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"Language for backend payment method names","format":"string","in":"path"}]}},"\/rest\/payments\/methods\/list\/backend_icon":{"get":{"summary":"Get payment methods and icons","description":"Returns all payment methods with id and backend icon url","tags":["Payment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":{"6000":"","6005":"debitIcon.svg"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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":"Get searchable payment methods","description":"Returns all payment methods with id and name which are searchable for the backend","tags":["Payment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":{"6000":"Cash In Advance","6005":"Debit"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"Language for backend payment method names","format":"string","in":"path"}]}},"\/rest\/payments\/methods\/list\/documentbuilder_active\/{language}":{"get":{"summary":"Get DocumenBuilder active payment methods","description":"Get DocumenBuilder active payment methods","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":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/payments\/methods\/list\/handle_subscription\/{language}":{"get":{"summary":"Get subscriptions handling payment methods","description":"List all payment methods which can handle subscriptions","tags":["Payment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":{"6000":"Cash In Advance","6005":"Debit"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"Language for backend payment method names","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"}},"examples":{"application\/json":[{"pluginKey":"plenty","paymentKey":"morissette.bailee","name":"herman.ila"},{"pluginKey":"plenty","paymentKey":"vstiedemann","name":"qhammes"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/preview\/{language}":{"get":{"summary":"Get preview list for payment method","description":"Get an array with all payment methods with the ID as key and the name as value.","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":"Language for payment method names","format":"string","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"}},"examples":{"application\/json":[{"hash":"VcB@o)\/2$4Wer,vuN{","importedAt":"2021-12-03T06:59:00+01:00"},{"hash":"NDVeE*(4Ou.E_\\(","importedAt":"2021-12-03T06:59:00+01:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/order\/{orderId}":{"delete":{"summary":"Detach all the payment from and order.","description":"Detach all payments, updates order paid amount,adds an entry in the order history and update order stock based on order settings.","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":"orderId","type":"integer","required":true,"description":"An order ID.","format":"integer","in":"path"}]}},"\/rest\/payments\/orders\/autoassign\/bulk":{"post":{"summary":"Assign Payments","description":"Bulk auto assign payments specified by their ids.","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":"ids","type":"array","required":false,"description":"An array with payment ids to be autoassigned. Eg: ['ids' => [1,2,3]]","format":"","in":"query","items":{"type":"integer"}}]}},"\/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"}},"examples":{"application\/json":[{"hash":"yD+|z)","importedAt":"2021-12-03T06:59:00+01:00"},{"hash":"o=fNk9M>1akx","importedAt":"2021-12-03T06:59:00+01:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"List all available payment properties.","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 property","description":"Create a new payment property.","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","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 rate = 36\n matching to \/^[0-9]+$\/"},"value":{"type":"string","description":"The value of the property type optional matching to \/.{0,255}\/"}}}}]},"put":{"summary":"Update property","description":"Update a payment property","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","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 rate = 36\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 property type","description":"Create a property type","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","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 property type","description":"Update a property type","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","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"}},"examples":{"application\/json":[{"hash":"78]6{Qw2'u5uA4x","importedAt":"2021-12-03T06:59:00+01:00"},{"hash":"GEdz&L@PL3QdNMg-euO","importedAt":"2021-12-03T06:59:00+01:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/search":{"get":{"summary":"Search payments","description":"Search payments by defined filters which can be send with the request.","tags":["Payment"],"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 Payment","items":{"$ref":"#\/definitions\/Payment"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"hash":"\";S8;\\nIhppy`H3","importedAt":"2021-12-03T06:59:00+01:00"},{"hash":"I}0ljh'k","importedAt":"2021-12-03T06:59:00+01:00"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":false,"description":"Filter restricts the list of results to payments with the given payment ID\/IDs. For example, ...\/search?paymentId=140 will search for payment ID 140 and ...\/search?paymentId=in:30,31 will search for payment ids 30 and 31","format":"integer","in":"query"},{"name":"status","type":"integer","required":false,"description":"Filter restricts the list of results to payments with the given status ID.","format":"integer","in":"query"},{"name":"type","type":"string","required":false,"description":"Filter restricts the list of results to payments with the given payment type. For example, ...\/search?type=credit will list payments with payment type credit. Available payment types: 'credit' and 'debit'.","format":"string","in":"query"},{"name":"amount","type":"integer","required":false,"description":"Filter restricts the list of results to payments with the given payment amount. For example, ...\/search?amount=between:120,250 will list all payments with amount between 120 and 250.","format":"integer","in":"query"},{"name":"transactionType","type":"integer","required":false,"description":"Filter restricts the list of results to payments with the given transaction type ID.","format":"integer","in":"query"},{"name":"currency","type":"string","required":false,"description":"Currency iso code. Eg: EUR","format":"string","in":"query"},{"name":"receivedAt","type":"string","required":false,"description":"Filter restricts the list of results to payments received during the specified period. The end date (to) is optional. If no end date is specified, payments received in the specified day will be listed. The dates can be specified in the ISO 8601 date format. Start date and optional end date are separated by a comma. For example, ...\/search?receivedAt=2020-04-16T00:00:00+03:00,2020-05-16T00:00:00+03:00 will list payments received between 2020-04-16 00:00 and 2020-05-16 23:59. ...\/search?receivedAt=2020-04-16T00:00:00+03:00 will list payments created on 2020-04-16.","format":"string","in":"query"},{"name":"importedAt","type":"string","required":false,"description":"Filter restricts the list of results to payments imported during the specified period. The end date (to) is optional. If no end date is specified, payments imported in the specified day will be listed. The dates can be specified in the ISO 8601 date format. Start date and optional end date are separated by a comma. For example, ...\/search?importedAt=2020-04-16T00:00:00+03:00,2020-05-16T00:00:00+03:00 will list payments imported between 2020-04-16 00:00 and 2020-05-16 23:59. ...\/search?importedAt=2020-04-16T00:00:00+03:00 will list payments imported on 2020-04-16.","format":"string","in":"query"},{"name":"assignedAt","type":"string","required":false,"description":"Filter restricts the list of results to payments imported during the specified period. The end date (to) is optional. If no end date is specified, payments imported in the specified day will be listed. The dates can be specified in the ISO 8601 date format. Start date and optional end date are separated by a comma. For example, ...\/search?importedAt=2020-04-16T00:00:00+03:00,2020-05-16T00:00:00+03:00 will list payments imported between 2020-04-16 00:00 and 2020-05-16 23:59. ...\/search?importedAt=2020-04-16T00:00:00+03:00 will list payments imported on 2020-04-16.","format":"string","in":"query"},{"name":"mopId","type":"integer","required":false,"description":"Filter restricts the list of results to payments through the give payment method(mopId).","format":"integer","in":"query"},{"name":"orderId","type":"integer","required":false,"description":"Filter restricts the list of results to payments assigned to the given order(orderId). For example, ...\/search?orderId=14 will search for order ID 14 and ...\/search?orderId=in:3,4 will search for order ids 3 and 4","format":"integer","in":"query"},{"name":"assignment","type":"integer","required":false,"description":"Filter restricts the list of results to payments which are assigned or detached. 1 = Assigned, 0 = Detached.","format":"integer","in":"query"},{"name":"transactionId","type":"string","required":false,"description":"Filter restricts the list of results to payments that have the property type ID 1 and property value contains a given value. For example, ...\/search?transactionId=1,test will list all payments that have the property type ID 1 and property value contains the text 'test'.","format":"string","in":"query"},{"name":"referenceId","type":"string","required":false,"description":"Filter restricts the list of results to payments that have the property type ID 1 and property value contains a given value. For example, ...\/search?transactionId=1,test will list all payments that have the property type ID 1 and property value contains the text 'test'.","format":"string","in":"query"},{"name":"bookingText","type":"string","required":false,"description":"Filter restricts the list of results to payments that have the property type ID 1 and property value contains a given value. For example, ...\/search?transactionId=1,test will list all payments that have the property type ID 1 and property value contains the text 'test'.","format":"string","in":"query"},{"name":"transactionCode","type":"string","required":false,"description":"Filter restricts the list of results to payments that have the property type ID 1 and property value contains a given value. For example, ...\/search?transactionId=1,test will list all payments that have the property type ID 1 and property value contains the text 'test'.","format":"string","in":"query"},{"name":"orderBy","type":"string","required":false,"description":"Allows you to sort payments by a given column and a certain order. For examople: ...\/search?orderBy=id:desc will sort payments by column id descending","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"},{"name":"with","type":"array","required":false,"description":"The relations to load with the payment object. The relations available are parent, method, histories, properties, order or contact.","format":"","in":"query","items":{"type":"string"}}]},"post":{"summary":"Search payments","description":"Search payments by defined filters which can be send with the request.","tags":["Payment"],"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 Payment","items":{"$ref":"#\/definitions\/Payment"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"hash":"Ip~kSjH2\"e&oak+#S2E","importedAt":"2021-12-03T06:59:00+01:00"},{"hash":"zi1XQ&|^kAq&OS]%<0R","importedAt":"2021-12-03T06:59:00+01:00"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":false,"description":"Filter restricts the list of results to payments with the given payment ID\/IDs. For example, ...\/search?paymentId=140 will search for payment ID 140 and ...\/search?paymentId=in:30,31 will search for payment ids 30 and 31","format":"integer","in":"query"},{"name":"status","type":"integer","required":false,"description":"Filter restricts the list of results to payments with the given status ID.","format":"integer","in":"query"},{"name":"type","type":"string","required":false,"description":"Filter restricts the list of results to payments with the given payment type. For example, ...\/search?type=credit will list payments with payment type credit. Available payment types: 'credit' and 'debit'.","format":"string","in":"query"},{"name":"amount","type":"integer","required":false,"description":"Filter restricts the list of results to payments with the given payment amount. For example, ...\/search?amount=between:120,250 will list all payments with amount between 120 and 250.","format":"integer","in":"query"},{"name":"transactionType","type":"integer","required":false,"description":"Filter restricts the list of results to payments with the given transaction type ID.","format":"integer","in":"query"},{"name":"currency","type":"string","required":false,"description":"Currency iso code. Eg: EUR","format":"string","in":"query"},{"name":"receivedAt","type":"string","required":false,"description":"Filter restricts the list of results to payments received during the specified period. The end date (to) is optional. If no end date is specified, payments received in the specified day will be listed. The dates can be specified in the ISO 8601 date format. Start date and optional end date are separated by a comma. For example, ...\/search?receivedAt=2020-04-16T00:00:00+03:00,2020-05-16T00:00:00+03:00 will list payments received between 2020-04-16 00:00 and 2020-05-16 23:59. ...\/search?receivedAt=2020-04-16T00:00:00+03:00 will list payments created on 2020-04-16.","format":"string","in":"query"},{"name":"importedAt","type":"string","required":false,"description":"Filter restricts the list of results to payments imported during the specified period. The end date (to) is optional. If no end date is specified, payments imported in the specified day will be listed. The dates can be specified in the ISO 8601 date format. Start date and optional end date are separated by a comma. For example, ...\/search?importedAt=2020-04-16T00:00:00+03:00,2020-05-16T00:00:00+03:00 will list payments imported between 2020-04-16 00:00 and 2020-05-16 23:59. ...\/search?importedAt=2020-04-16T00:00:00+03:00 will list payments imported on 2020-04-16.","format":"string","in":"query"},{"name":"assignedAt","type":"string","required":false,"description":"Filter restricts the list of results to payments imported during the specified period. The end date (to) is optional. If no end date is specified, payments imported in the specified day will be listed. The dates can be specified in the ISO 8601 date format. Start date and optional end date are separated by a comma. For example, ...\/search?importedAt=2020-04-16T00:00:00+03:00,2020-05-16T00:00:00+03:00 will list payments imported between 2020-04-16 00:00 and 2020-05-16 23:59. ...\/search?importedAt=2020-04-16T00:00:00+03:00 will list payments imported on 2020-04-16.","format":"string","in":"query"},{"name":"mopId","type":"integer","required":false,"description":"Filter restricts the list of results to payments through the give payment method(mopId).","format":"integer","in":"query"},{"name":"orderId","type":"integer","required":false,"description":"Filter restricts the list of results to payments assigned to the given order(orderId). For example, ...\/search?orderId=14 will search for order ID 14 and ...\/search?orderId=in:3,4 will search for order ids 3 and 4","format":"integer","in":"query"},{"name":"assignment","type":"integer","required":false,"description":"Filter restricts the list of results to payments which are assigned or detached. 1 = Assigned, 0 = Detached.","format":"integer","in":"query"},{"name":"transactionId","type":"string","required":false,"description":"Filter restricts the list of results to payments that have the property type ID 1 and property value contains a given value. For example, ...\/search?transactionId=1,test will list all payments that have the property type ID 1 and property value contains the text 'test'.","format":"string","in":"query"},{"name":"referenceId","type":"string","required":false,"description":"Filter restricts the list of results to payments that have the property type ID 1 and property value contains a given value. For example, ...\/search?transactionId=1,test will list all payments that have the property type ID 1 and property value contains the text 'test'.","format":"string","in":"query"},{"name":"bookingText","type":"string","required":false,"description":"Filter restricts the list of results to payments that have the property type ID 1 and property value contains a given value. For example, ...\/search?transactionId=1,test will list all payments that have the property type ID 1 and property value contains the text 'test'.","format":"string","in":"query"},{"name":"transactionCode","type":"string","required":false,"description":"Filter restricts the list of results to payments that have the property type ID 1 and property value contains a given value. For example, ...\/search?transactionId=1,test will list all payments that have the property type ID 1 and property value contains the text 'test'.","format":"string","in":"query"},{"name":"orderBy","type":"string","required":false,"description":"Allows you to sort payments by a given column and a certain order. For examople: ...\/search?orderBy=id:desc will sort payments by column id descending","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"},{"name":"with","type":"array","required":false,"description":"The relations to load with the payment object. The relations available are parent, method, histories, properties, order or contact.","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/payments\/status\/{statusId}":{"get":{"summary":"List payments of a payment status","description":"Lists all payments of a payment status. The ID of the <a href='https:\/\/developers.plentymarkets.com\/en-gb\/developers\/main\/rest-api-guides\/getting-started.html#_payment_status_ids' target='_blank'>payment status<\/a> must be specified.","tags":["Payment"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/Payment"}},"examples":{"application\/json":[{"hash":"6w&v&W'g","importedAt":"2021-12-03T06:59:00+01:00"},{"hash":"T<vRu3>{S)`evNw","importedAt":"2021-12-03T06:59:00+01:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"hash":"^Q6sS_FV%@*n0Vi-","importedAt":"2021-12-03T06:59:00+01:00"},{"hash":"8tYsMd'C!PG{","importedAt":"2021-12-03T06:59:00+01:00"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}":{"delete":{"summary":"Delete payment","description":"Delete payment. The ID of the payment must be specified.","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"}]},"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"},"examples":{"application\/json":{"hash":"5hru@Zi)k\\41PVGxi3$","importedAt":"2021-12-03T06:59:00+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/amazon-product-types":{"get":{"summary":"Get item amazon product types","description":"Gets a list of all amazon product types.","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":{"delete":{"summary":"Delete a list of attributes","description":"Deletes a list of 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 for attributes","description":"Searches attributes. Returns a paginated result.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"backendName":"6326c52b-25e5-36d9-919b-67c7055a995c","position":6,"isSurchargePercental":false,"isLinkableToImage":false,"amazonAttribute":"Quas quis omnis rerum alias expedita placeat. Mollitia a debitis voluptas in.","fruugoAttribute":"null","pixmaniaAttribute":9,"ottoAttribute":"Dimension2","googleShoppingAttribute":"none","neckermannAtEpAttribute":9,"typeOfSelectionInOnlineStore":"image","laRedouteAttribute":3,"isGroupable":false},{"backendName":"ed84e971-1d28-33da-9364-300e6a1a0920","position":7,"isSurchargePercental":false,"isLinkableToImage":false,"amazonAttribute":"Ut nihil laborum aut soluta. Qui rerum harum et deleniti.","fruugoAttribute":"color","pixmaniaAttribute":6,"ottoAttribute":"Dimension3","googleShoppingAttribute":"size","neckermannAtEpAttribute":0,"typeOfSelectionInOnlineStore":"image","laRedouteAttribute":3,"isGroupable":false}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li> 'attributeNames' = The attribute names of the attribute.<\/li><li> 'values' = The attribute values of the attribute.<\/li><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"},{"name":"sortBy","type":"string","required":false,"description":"Filter sorts the result of categories. 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:<ul><li>'id'<\/li><li>'position'<\/li><li>'name'<\/li><li>'level'<\/li><li>'parentCategoryId'<\/li><li>'updatedAt'<\/li><\/ul>","format":"string","in":"query"}]},"post":{"summary":"Create a list of attributes","description":"Creates a list of new 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."}},"parameters":[{"in":"body","name":"\/rest\/pim\/attributes","schema":{"type":"object","properties":{"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"},"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"},"attributeNames":{"type":"array","items":{"$ref":"#\/definitions\/AttributeName"}},"lang":{"type":"string","description":"The language of the attribute. allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"name":{"type":"string","description":"The name of the attribute. This attribute name is displayed in the online store."},"values":{"type":"array","items":{"$ref":"#\/definitions\/AttributeValue"}},"valueNames":{"type":"array","items":{}}}}}]},"put":{"summary":"Update a list of attributes","description":"Updates a list of 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."}},"parameters":[{"in":"body","name":"\/rest\/pim\/attributes","schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the attribute."},"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\/pim\/attributes\/names":{"delete":{"summary":"Delete a list of attribute names","description":"Deletes a list of 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. Returns a paginated result.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"attributeId":104,"lang":"ve","name":"Webster Falls"},{"attributeId":105,"lang":"uk","name":"Flo Rapid"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li> '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 a list of attribute names","description":"Creates a list of 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."}},"parameters":[{"in":"body","name":"\/rest\/pim\/attributes\/names","schema":{"type":"object","properties":{"attributeId":{"type":"integer","description":"The id of the attribute."},"lang":{"type":"string","description":"The language of the attribute. allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"name":{"type":"string","description":"The name of the attribute. This attribute name is displayed in the online store."}}}}]},"put":{"summary":"Update a list of attribute names","description":"Updates a list of 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."}},"parameters":[{"in":"body","name":"\/rest\/pim\/attributes\/names","schema":{"type":"object","properties":{"attributeId":{"type":"integer","description":"The id of the attribute."},"lang":{"type":"string","description":"The language of the attribute. allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"name":{"type":"string","description":"The name of the attribute. This attribute name is displayed in the online store."}}}}]}},"\/rest\/pim\/attributes\/values":{"delete":{"summary":"Delete a list of attribute values","description":"Deletes a list of 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. Returns a paginated result.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"attributeId":102,"backendName":"Kunze Vista","position":5,"image":"attr_6.png","comment":"Delectus qui sit ea aut dolorem in non accusantium officiis eum provident et blanditiis suscipit dolorem consequuntur perferendis accusamus esse molestiae quis dolorem ut qui.","amazonValue":"doloribus","ottoValue":"necessitatibus","neckermannAtEpValue":"minus","laRedouteValue":"incidunt","tracdelightValue":"labore","percentageDistribution":26},{"attributeId":103,"backendName":"Waldo Shoals","position":7,"image":"attr_6.png","comment":"Sed excepturi voluptatum odit beatae veniam sed quasi ut illum est amet assumenda ab et nisi commodi vero exercitationem quis.","amazonValue":"rem","ottoValue":"iusto","neckermannAtEpValue":"ipsam","laRedouteValue":"laborum","tracdelightValue":"vel","percentageDistribution":44}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li> 'valueNames' = The names of the attribute value.<\/li><li> 'attribute' = The attribute of the attribute value.<\/li><li> 'valueMaps' = The maps of the attribute value.<\/li><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 a list of attribute values","description":"Creates a list of 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 a list of attribute values","description":"Updates a list of 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 a list of attribute value names","description":"Deletes a list of 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. Returns a paginated result.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"valueId":89,"lang":"gu","name":"Gulgowski Plaza"},{"valueId":90,"lang":"kr","name":"Ida Village"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li> '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 a list of attribute value names","description":"Creates a list of 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."}},"parameters":[{"in":"body","name":"\/rest\/pim\/attributes\/values\/names","schema":{"type":"object","properties":{"valueId":{"type":"integer","description":"The unique ID of the attribute value."},"lang":{"type":"string","description":"The language of the attribute value. allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"name":{"type":"string","description":"The name of the attribute value. This attribute value name is displayed in the online store."}}}}]},"put":{"summary":"Update a list of attribute value names","description":"Updates a list of 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."}},"parameters":[{"in":"body","name":"\/rest\/pim\/attributes\/values\/names","schema":{"type":"object","properties":{"valueId":{"type":"integer","description":"The unique ID of the attribute value."},"lang":{"type":"string","description":"The language of the attribute value. allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"name":{"type":"string","description":"The name of the attribute value. This attribute value name is displayed in the online store."}}}}]}},"\/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"},"examples":{"application\/json":{"attributeId":101,"backendName":"Wintheiser Lodge","position":8,"image":"attr_6.png","comment":"Optio eaque sunt non sed maxime commodi eos amet praesentium quae adipisci rem ipsam laborum.","amazonValue":"officia","ottoValue":"dolore","neckermannAtEpValue":"dolorum","laRedouteValue":"unde","tracdelightValue":"praesentium","percentageDistribution":21}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"backendName":"57fd33c6-d3c3-3c05-9a63-b3a3b7418c80","position":7,"isSurchargePercental":true,"isLinkableToImage":false,"amazonAttribute":"Vero porro illum ea qui. Velit consequatur ipsam voluptas saepe.","fruugoAttribute":"size","pixmaniaAttribute":2,"ottoAttribute":"Dimension2","googleShoppingAttribute":"size","neckermannAtEpAttribute":6,"typeOfSelectionInOnlineStore":"dropdown","laRedouteAttribute":0,"isGroupable":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/barcodes":{"delete":{"summary":"Delete a list of barcodes","description":"Deletes a list of barcodes.","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 for barcodes","description":"Searches barcodes. Returns a paginated result.","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 Barcode","items":{"$ref":"#\/definitions\/Barcode"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"name":"evelyn.sporer","type":"GTIN_13"},{"name":"rgoldner","type":"GTIN_8"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li> 'referrers' = The referrers of the barcode <\/li><\/ub>","format":"string","in":"query"},{"name":"ids","type":"string","required":false,"description":"Filter restricts the result to barcodes 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":"code","type":"string","required":false,"description":"Filter restricts the result to barcodes with the specified code. More than one parameter should be separated by commas. Allowed comparators: 'eq' and 'in'.","format":"string","in":"query"},{"name":"type","type":"string","required":false,"description":"Filter restricts the result to barcodes with the specified type. More than one parameter should be separated by commas. Allowed comparator: 'eq', 'in' and 'not'.","format":"string","in":"query"},{"name":"referrerIds","type":"string","required":false,"description":"Filter restricts the result to barcodes with the specified referrers. More than one parameter should be separated by commas. Allowed comparator: 'eq' and 'in'.","format":"string","in":"query"}]},"post":{"summary":"Create a list of barcodes","description":"Creates a list of new barcodes.","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."}},"parameters":[{"in":"body","name":"\/rest\/pim\/barcodes","schema":{"type":"object","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"},"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."}}}}]},"put":{"summary":"Update a list of barcodes","description":"Updates a list of barcodes.","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."}},"parameters":[{"in":"body","name":"\/rest\/pim\/barcodes","schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the barcode"},"name":{"type":"string","description":"The name of the barcode optional"},"type":{"type":"string","description":"The type of the barcode. Possible values: GTIN_8, GTIN_13, GTIN_14, GTIN_128, ISBN, QR, CODE_128, UPC optional 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\/pim\/barcodes\/duplicates":{"get":{"summary":"Get all barcode duplicates","description":"Gets all duplicated barcodes.","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":{"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\/pim\/barcodes\/duplicates\/count":{"get":{"summary":"Get barcode duplicates","description":"Gets one duplicated barcode. The ID must be specified.","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":{"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\/pim\/barcodes\/duplicates\/settings":{"get":{"summary":"List barcodes duplicate settings","description":"List barcode duplicate settings. Duplicate barcode 1 = warning 2 = error","tags":["Pim"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/int"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/categories":{"get":{"summary":"Search categories","description":"Searches the categories. Returns a paginated result.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"parentCategoryId":null,"level":1,"type":"item","linklist":"N","right":"all","sitemap":"N"},{"parentCategoryId":null,"level":1,"type":"blog","linklist":"Y","right":"all","sitemap":"N"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li> 'details' = The names of the category.<\/li><li> 'clients' = The clients of the category.<\/li><li> 'branch' = The branch of the category.<\/li><li> 'tagRelationship' = The tags linked with the category and their data.<\/li><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":"parentCategoryId","type":"integer","required":false,"description":"Filter restricts the result to categories with the specified parent category 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"},{"name":"sortBy","type":"string","required":false,"description":"Filter sorts the result of categories. 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:<ul><li>'id'<\/li><li>'position'<\/li><li>'name'<\/li><li>'level'<\/li><li>'parentCategoryId'<\/li><li>'updatedAt'<\/li><\/ul>","format":"string","in":"query"}]}},"\/rest\/pim\/categories\/branches":{"get":{"summary":"Search category branches","description":"Searches category branches. Returns a paginated result.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"categoryId":0,"category1Id":4,"category2Id":0,"category3Id":4,"category4Id":1,"category5Id":9,"category6Id":2},{"categoryId":4,"category1Id":7,"category2Id":0,"category3Id":5,"category4Id":5,"category5Id":8,"category6Id":1}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li> '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. Returns a paginated result.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"plentyId":65411},{"plentyId":65411}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li> '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. Returns a paginated result.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"categoryId":6,"lang":"rk","name":"hic","description":"Voluptatem dolore adipisci consequatur reiciendis. Recusandae ab sit odio maiores fugiat totam. A velit veniam iste exercitationem praesentium saepe id. Velit assumenda enim voluptas.","description2":"Quaerat voluptate possimus voluptatem ipsam. Officiis dolorum fugiat animi sed magnam modi. Sunt maxime ex et explicabo. Officia et nam voluptas alias hic et.","shortDescription":"Aut quibusdam voluptas perferendis est.","metaKeywords":"non, amet, ut","metaDescription":"Maiores veniam a qui quidem dolor.","nameUrl":"quis","metaTitle":"autem","position":7,"itemListView":"ItemViewCategoriesList9","singleItemView":"ItemViewSingleItem","pageView":"PageDesignCustom2","fulltext":"Y","metaRobots":"INDEX","canonicalLink":"http:\/\/www.moore.net\/corrupti-laboriosam-optio-placeat-exercitationem-laudantium-aut","updatedBy":"duncan86","image":null,"imagePath":null,"image2":null,"image2Path":null,"plentyId":65411},{"categoryId":1,"lang":"id","name":"at","description":"Nobis non neque ea recusandae modi. Ex voluptas occaecati reiciendis illum perferendis ratione libero. Qui doloremque rerum at ea id aspernatur eaque. Aut ut perspiciatis porro est minus.","description2":"Voluptates officiis ipsa exercitationem ipsam sapiente voluptate. Saepe inventore non aliquid et id tenetur laboriosam. Ex non aut ipsa rem.","shortDescription":"Velit ab soluta quas voluptas nihil totam quis sed.","metaKeywords":"velit, quia, quae","metaDescription":"Ut numquam excepturi commodi sint.","nameUrl":"ipsa","metaTitle":"facilis","position":45,"itemListView":"ItemViewCategoriesList2","singleItemView":"ItemViewSingleItem4","pageView":"PageDesignCustom2","fulltext":"N","metaRobots":"NOINDEX","canonicalLink":"http:\/\/www.moen.com\/soluta-aut-reiciendis-et.html","updatedBy":"rogahn.alejandra","image":null,"imagePath":null,"image2":null,"image2Path":null,"plentyId":65411}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li> '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 language. 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 name. More than one parameter should be separated by commas. Allowed comparators: 'eq' and 'like'.","format":"string","in":"query"},{"name":"nameUrl","type":"string","required":false,"description":"Filter restricts the result to category details with the specified name url. More than one parameter should be separated by commas. Allowed comparators: 'eq' and 'like'.","format":"string","in":"query"},{"name":"metaKeywords","type":"string","required":false,"description":"Filter restricts the result to category details with the specified meta keywords. 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 position. 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. Returns a paginated result.","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:<ul><li> '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 by given ID","description":"Gets one category. The ID must be specified.","tags":["Pim"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Category"},"examples":{"application\/json":{"parentCategoryId":null,"level":1,"type":"content","linklist":"N","right":"customer","sitemap":"N"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/item-serial-numbers":{"delete":{"summary":"Delete item serial numbers","description":"Deletes a list of item serial numbers. Returns a collection","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 for item serial numbers","description":"Search for item serial numbers. Gets a paginated list.","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 ItemSerialNumber","items":{"$ref":"#\/definitions\/ItemSerialNumber"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"orderId":778,"orderItemId":312,"itemId":6479,"serialNumber":"141136403674","createdAt":"2021-04-02T04:45:27+02:00"},{"orderId":438,"orderItemId":362,"itemId":9662,"serialNumber":"078387729231","createdAt":"2018-03-08T02:54:18+01:00"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 serial numbers","description":"Creates a list of item serial numbers. Returns a collection","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."}},"parameters":[{"in":"body","name":"\/rest\/pim\/item-serial-numbers","schema":{"type":"object","properties":{"itemId":{"type":"integer","description":"The ID of the item"},"serialNumber":{"type":"string","description":"The serial number"},"orderId":{"type":"integer","description":"The ID of the order optional"},"orderItemId":{"type":"integer","description":"The ID of the order item optional"}}}}]},"put":{"summary":"Update item serial numbers","description":"Updates a list of item serial numbers. Returns a collection","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."}},"parameters":[{"in":"body","name":"\/rest\/pim\/item-serial-numbers","schema":{"type":"object","properties":{"itemId":{"type":"integer","description":"The ID of the item"},"serialNumber":{"type":"string","description":"The serial number"},"orderId":{"type":"integer","description":"The ID of the order optional"},"orderItemId":{"type":"integer","description":"The ID of the order item optional"}}}}]}},"\/rest\/pim\/items\/{id}\/attributes":{"get":{"summary":"Get Attributes linked to given item","description":"List of all attributes for current item. Returns an array.","tags":["Pim"],"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"}]}},"\/rest\/pim\/items\/{id}\/combinations":{"get":{"summary":"Get all existing variation combinations for current item","description":"List of all existing unit and attribute combinations for current item. Returns an array.\n*","tags":["Pim"],"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"}]}},"\/rest\/pim\/sales_prices":{"delete":{"summary":"Delete a list of sales prices","description":"Deletes a list of sales prices.","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."}},"parameters":[{"in":"body","name":"\/rest\/pim\/sales_prices","schema":{"type":"object","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, set, 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"}}}}]},"get":{"summary":"Search for sales prices","description":"Searches for sales prices.","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 SalesPrice","items":{"$ref":"#\/definitions\/SalesPrice"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"position":96,"minimumOrderQuantity":63.99,"type":"default","isCustomerPrice":true,"isDisplayedByDefault":false,"isLiveConversion":false,"interval":"semi-annual"},{"position":41,"minimumOrderQuantity":94.42,"type":"default","isCustomerPrice":true,"isDisplayedByDefault":true,"isLiveConversion":false,"interval":"daily"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>accounts = The accounts of the sales price.<\/li><li>clients = The clients of the sales price.<\/li><li>countries = The countries of the sales price.<\/li><li>currencies = The currencies of the sales price.<\/li><li>customerClasses = The customer classes of the sales price.<\/li><li>names = The names of the sales price.<\/li><li>referrers = The referrer of the sales price.<\/li><\/ub>","format":"string","in":"query"},{"name":"ids","type":"string","required":false,"description":"Filter restricts the result to sales prices 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 sales prices with the specified type. Allowed comparators: 'eq' and 'in'.","format":"string","in":"query"},{"name":"customerClassId","type":"integer","required":false,"description":"Filter restricts the result to sales prices with the specified customer class.","format":"integer","in":"query"},{"name":"currency","type":"integer","required":false,"description":"Filter restricts the result to sales prices with the specified currency.","format":"integer","in":"query"},{"name":"countryId","type":"integer","required":false,"description":"Filter restricts the result to sales prices with the specified country.","format":"integer","in":"query"},{"name":"name","type":"string","required":false,"description":"Filter restricts the result to sales prices with the specified name.","format":"string","in":"query"},{"name":"referrerId","type":"integer","required":false,"description":"Filter restricts the result to sales prices with the specified referrer.","format":"integer","in":"query"},{"name":"plentyId","type":"integer","required":false,"description":"Filter restricts the result to sales prices with the specified plenty ID.","format":"integer","in":"query"},{"name":"updatedAt","type":"string","required":false,"description":"Filter restricts the result to sales prices 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 a list of sales prices","description":"Creates a list of sales prices.","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."}},"parameters":[{"in":"body","name":"\/rest\/pim\/sales_prices","schema":{"type":"object","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, set, 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"}}}}]},"put":{"summary":"Update a list of sales prices","description":"Updates a list of sales prices.","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."}},"parameters":[{"in":"body","name":"\/rest\/pim\/sales_prices","schema":{"type":"object","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, set, 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\/pim\/sales_prices\/{id}":{"get":{"summary":"Get one sales price by ID","description":"Gets one sales price. The ID must be specified.","tags":["Pim"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/SalesPrice"},"examples":{"application\/json":{"position":52,"minimumOrderQuantity":86.29,"type":"rrp","isCustomerPrice":true,"isDisplayedByDefault":true,"isLiveConversion":true,"interval":"monthly"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>accounts<\/li><li>clients<\/li><li>countries<\/li><li>currencies<\/li><li>customerClasses<\/li><li>names<\/li><li>referrers<\/li><\/ub>","format":"string","in":"query"},{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/pim\/variations":{"delete":{"summary":"Delete a list of variations","description":"Deletes a list of variations.","tags":["Pim"],"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":[{"in":"body","name":"\/rest\/pim\/variations","schema":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the variation. optional"},"additionalSkus":{"type":"array","items":{"$ref":"#\/definitions\/AdditionalSku"}},"attributeValues":{"type":"array","items":{"$ref":"#\/definitions\/AttributeValue"}},"barcodes":{"type":"array","items":{"$ref":"#\/definitions\/Barcode"}},"bundleComponents":{"type":"array","items":{"$ref":"#\/definitions\/BundleComponent"}},"categories":{"type":"array","items":{"$ref":"#\/definitions\/Category"}},"clients":{"type":"array","items":{"$ref":"#\/definitions\/Client"}},"defaultCategories":{"type":"array","items":{"$ref":"#\/definitions\/DefaultCategory"}},"images":{"type":"array","items":{"$ref":"#\/definitions\/Image"}},"markets":{"type":"array","items":{"$ref":"#\/definitions\/Market"}},"marketIdentNumbers":{"type":"array","items":{"$ref":"#\/definitions\/MarketIdentNumber"}},"salesPrices":{"type":"array","items":{"$ref":"#\/definitions\/SalesPrice"}},"skus":{"type":"array","items":{"$ref":"#\/definitions\/Sku"}},"supplier":{"type":"array","items":{"$ref":"#\/definitions\/Supplier"}},"warehouses":{"type":"array","items":{"$ref":"#\/definitions\/Warehouse"}},"properties":{"type":"array","items":{"$ref":"#\/definitions\/Property"}},"tags":{"type":"array","items":{"$ref":"#\/definitions\/Tag"}},"comments":{"type":"array","items":{"$ref":"#\/definitions\/Comment"}},"inheritance":{"type":"array","items":{"$ref":"#\/definitions\/Inheritance"}},"unit":{"type":"array","items":{"$ref":"#\/definitions\/Unit"}},"base":{"type":"array","items":{"$ref":"#\/definitions\/Base"}}}}}]},"get":{"summary":"List variations including the specified related data","description":"Lists variations including the in 'with' specified related 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"exception":"Source and target directories must differ.","categories":[],"barcodes":[],"additionalSkus":[],"attributeValues":[],"bundleComponents":[],"clients":[],"defaultCategories":[],"images":[],"marketIdentNumbers":[],"markets":[],"salesPrices":[],"skus":[],"supplier":[],"warehouses":[],"properties":[],"tags":[],"comments":[]},{"id":19597,"base":{"isMain":false,"itemId":10048,"position":65,"isActive":true,"number":"P-304732","model":"et","externalId":null,"availability":1,"estimatedAvailableAt":"2025-09-21T10:29:13+0200","purchasePrice":57.16,"createdAt":"2025-08-17T19:48:02+0200","updatedAt":"2025-08-29T23:29:59+0200","relatedUpdatedAt":"2025-08-31T02:20:14+0200","priceCalculationId":null,"picking":null,"stockLimitation":2,"isVisibleIfNetStockIsPositive":false,"isInvisibleIfNetStockIsNotPositive":false,"isAvailableIfNetStockIsPositive":true,"isUnavailableIfNetStockIsNotPositive":true,"mainWarehouseId":181,"maximumOrderQuantity":78.46,"minimumOrderQuantity":47.98,"intervalOrderQuantity":42.98,"availableUntil":"2025-09-22T07:36:26+0200","releasedAt":"2025-09-02T04:12:29+0200","name":"raynor.florian","weightG":7,"weightNetG":3,"widthMM":4,"lengthMM":8,"heightMM":1,"extraShippingCharge1":49.2,"extraShippingCharge2":76.53,"unitsContained":8,"palletTypeId":8,"packingUnits":7,"packingUnitTypeId":2,"transportationCosts":74.44,"storageCosts":12.31,"customs":60.11,"operatingCosts":24.58,"vatId":1,"bundleType":"bundle","automaticClientVisibility":true,"isHiddenInCategoryList":false},"additionalSkus":[{"marketId":4.06,"marketAccountId":27586,"sku":"6266753375"},{"marketId":104.06,"marketAccountId":47733,"sku":"4795278547"}],"attributeValues":[{"attributeId":97,"attributeValueSetId":110,"valueId":85},{"attributeId":98,"attributeValueSetId":669,"valueId":86}],"barcodes":[{"barcodeId":16,"code":"1489233101965"},{"barcodeId":17,"code":"0080463392119"}],"bundleComponents":[{"componentVariationId":99153,"componentQuantity":8},{"componentVariationId":99154,"componentQuantity":2}],"categories":[{"categoryId":17,"position":3,"isNeckermannPrimary":true},{"categoryId":1,"position":3,"isNeckermannPrimary":false}],"clients":[{"plentyId":18984},{"plentyId":10098}],"comments":[{"id":907,"userId":null,"text":"Ut nostrum aut occaecati dolorem velit illo voluptas officia.","isVisibleForContact":true},{"id":671,"userId":null,"text":"Officiis dolores totam aut laboriosam eum facilis.","isVisibleForContact":true}],"defaultCategories":[{"branchId":52,"manually":false,"plentyId":10085},{"branchId":36,"manually":false,"plentyId":19639}],"images":[{"imageId":63},{"imageId":64}],"markets":[{"marketId":81.58},{"marketId":99.23}],"marketIdentNumbers":[{"id":433,"countryId":8,"type":"epid","position":5,"value":"0380784785"},{"id":395,"countryId":6,"type":"epid","position":3,"value":"3160354008"}],"properties":[{"propertyId":644,"value":null},{"propertyId":645,"value":null,"selectionValues":null}],"salesPrices":[{"salesPriceId":54,"price":433.06},{"salesPriceId":69,"price":235.12}],"skus":[{"marketId":118,"accountId":6,"initialSku":"","sku":"1119545382","parentSku":"883","isActive":true,"status":"SENT","additionalInformation":"eaque"},{"marketId":113,"accountId":6,"initialSku":"","sku":"1753694868","parentSku":"863","isActive":false,"status":"SENT","additionalInformation":"explicabo"}],"supplier":[{"supplierId":92,"purchasePrice":1385,"minimumPurchase":5,"itemNumber":"9789458563084","lastPriceQuery":"1984-06-30T00:00:00+02:00","deliveryTimeInDays":6,"discount":42113.56,"isDiscountable":false,"packagingUnit":62207},{"supplierId":65,"purchasePrice":16042.34008285,"minimumPurchase":3,"itemNumber":"9784358456498","lastPriceQuery":"2013-04-03","deliveryTimeInDays":8,"discount":3.47,"isDiscountable":true,"packagingUnit":409158975}],"tags":[{"tagId":1069},{"tagId":1070}],"timestamps":{"availability":"2025-09-03T05:52:45+02:00","additionalSku":"2025-09-01T03:26:15+02:00","barcode":"2025-08-30T13:29:10+02:00","base":"2025-08-29T17:50:05+02:00","bundleComponent":"2025-09-02T01:05:25+02:00","category":"2025-08-27T12:43:55+02:00","client":"2025-08-29T08:31:50+02:00","defaultCategory":"2025-09-01T22:39:37+02:00","image":"2025-09-01T21:30:07+02:00","market":"2025-09-02T00:07:32+02:00","marketIdentNumber":"2025-09-02T20:20:51+02:00","related":"2025-08-28T07:59:41+02:00","salesPrice":"2025-08-27T15:42:23+02:00","sku":"2025-09-02T12:19:01+02:00","supplier":"2025-08-28T03:35:18+02:00","property":"2025-08-31T12:45:27+02:00","warehouse":"2025-08-31T15:32:15+02:00","tag":"2025-08-27T11:49:13+02:00","comment":"2025-09-02T12:23:39+02:00","createdAt":"2025-08-30T16:16:22+02:00"},"unit":{"unitId":123,"unitCombinationId":113,"content":495},"warehouses":[{"warehouseId":184,"zoneId":8,"storageLocationType":"europallet","reorderLevel":5,"maximumStock":9,"stockTurnoverInDays":5,"storageLocation":5,"stockBuffer":1,"isBatch":true,"isBestBeforeDate":true},{"warehouseId":185,"zoneId":6,"storageLocationType":"small","reorderLevel":5,"maximumStock":6,"stockTurnoverInDays":4,"storageLocation":2,"stockBuffer":1,"isBatch":true,"isBestBeforeDate":false}]}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'additionalSkus' = The additional skus of the variation.<\/li><li>'attributeValues' = The attribute values of the variation.<\/li><li>'attributeValues.attribute' = Includes attributeValues. The attribute data to the related attribute ID.<\/li><li>'attributeValues.attributeValue' = Includes attributeValues. The attribute value data to the related attribute value ID.<\/li><li>'barcodes' = The barcodes of the variation.<\/li><li>'barcodes.barcode' = Includes barcodes. The barcode data to the related barcode ID.<\/li><li>'base' = The variation base.<\/li><li>'base.item' = Includes base. The item data of the variation.<\/li><li>'base.itemSerialNumber' = Includes base. The item serial numbers of the variation.<\/li><li>'base.feedback' = Includes base. The feedback of the variation.<\/li><li>'base.characteristics' = Includes base. The characteristics of the variation.<\/li><li>'base.crossSelling' = Includes base. The cross selling items of the variation.<\/li><li>'base.texts' = Includes base. The texts of the variation.<\/li><li>'base.availability' = Includes base. The availability data related to the variation's availability ID.<\/li><li>'base.images' = Includes base. The images linked to the item.<\/li><li>'base.shippingProfiles' = Includes base. The shipping profiles linked to the item.<\/li><li>'base.stock' = Includes base. The stock of the variation.<\/li><li>'base.stockStorageLocations' = Includes base. The stock storage locations of the variation.<\/li><li>'bundleComponents' = The bundle components of the variation.<\/li><li>'categories' = The categories of the variation.<\/li><li>'categories.category' = Includes categories. The related category data for each category ID.<\/li><li>'categories.categoryBranch' = Includes categories. The related category branch data for each category ID.<\/li><li>'clients' = The clients of the variation.<\/li><li>'defaultCategories' = The default categories of the variation<\/li><li>'defaultCategories.category' = Includes defaultCategories. The category data to the related category ID.<\/li><li>'images' = The images of the variation<\/li><li>'images.image' = Includes images. The image data to the related image ID.<\/li><li>'markets' = The markets of the variation.<\/li><li>'marketIdentNumbers' = The market ident numbers of the variation<\/li><li>'salesPrices' = The sales prices of the variation.<\/li><li>'salesPrices.salesPrice' = Includes salesPrices. The sales price data to the related sales price ID.<\/li><li>'skus' = The skus of the variation.<\/li><li>'supplier' = The supplier of the variation.<\/li><li>'supplier.supplier' = Includes supplier. The contact data to the related supplier ID.<\/li><li>'timestamps' = The timetamps of the variation.<\/li><li>'warehouses' = The warehouses of the variation<\/li><li>'warehouses.warehouse' = Includes warehouses. The warehouse data to the related warehouse ID.<\/li><li>'unit' = The unit of the variation<\/li><li>'unit.unit' = Includes unit. The unit data of the related unit ID.<\/li><li>'tags' = The tags of the variation.<\/li><li>'tags.tag' = Includes tags. The tag data to the related tag ID.<\/li><li>'properties' = The properties of the variation.<\/li><li>'properties.property' = Includes properties. The property data to the related property ID.<\/li><li>'comments' = The comments of the variation.<\/li><li>'inheritance' = The inheritance of the variation.<\/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:<ul><li>'id'<\/li><li>'itemId'<\/li><li>'isMain'<\/li><li>'position'<\/li><li>'availabilityId'<\/li><li>'createdAt'<\/li><li>'updatedAt'<\/li><li>'itemUpdatedAt'<\/li><li>'relatedUpdatedAt'<\/li><\/ul>","format":"string","in":"query"},{"name":"groupBy","type":"string","required":false,"description":"Groups the result. The following parameters are available:<ul><li>'itemId' = Groups the result by the item ID.<\/li><li>'itemAttributeValue' = Groups the result by the attribute with the flag 'isGroupable'.<\/li><\/ul>","format":"string","in":"query"},{"name":"query","type":"string","required":false,"description":"Filter restricts the list of results to variations matching the specified query","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. If you use this filter no other filter will be considered. Limited to 500 ids","format":"string","in":"query"},{"name":"itemId","type":"integer","required":false,"description":"Filter restricts the list of results to variations with the specified item ID. Limited to 100 ids","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":"number","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":"hasListing","type":"boolean","required":false,"description":"Filter restricts the list of results to variations which have at least one or no listing.","format":"boolean","in":"query"},{"name":"marketId","type":"number","required":false,"description":"Filter restricts the list of results to variations which have the specified market ID.","format":"number","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":"referrerIds","type":"string","required":false,"description":"Filter restricts the list of results to variations which have\/not 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 result to variations which have a price for the given sales price ID within the specified range. Price ID, from and to value should be separated by a semicolon. Multiple IDs are separated by comma. Allowed comparators: none.","format":"string","in":"query"},{"name":"priceCalculationUuid","type":"string","required":false,"description":"Filter restricts the result to variations which have a price for the given sales price calculation uuid. Allowed comparators: 'eq'","format":"string","in":"query"},{"name":"salesPriceIds","type":"string","required":false,"description":"Filter restricts the list of results to variations which match specified sales price IDs criteria. More than one parameter should be separated by commas.","format":"string","in":"query"},{"name":"propertyId","type":"string","required":false,"description":"Filter restricts the list of results based on property IDs. Use 'in:' or 'nin:' prefix followed by comma-separated IDs (e.g., 'in:3,4,5' or 'nin:2,5,6'). Allowed operators: 'in', 'nin'.","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. Allowed operators: 'eq'.","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. Multiple IDs are separated by commas. Allowed operators: 'in'.","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. Multiple IDs are separated by commas. Allowed operators: 'all'.","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. Multiple IDs are separated by commas. Allowed operators: 'in'.","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":"bundleComponentVariationId","type":"integer","required":false,"description":"Filter restricts the list of results to variations which have the specified bundle component variation ID.","format":"integer","in":"query"},{"name":"warehouseIds","type":"string","required":false,"description":"Filter restricts the result to variations which meet the specified warehouse id criteria. Allowed operators are: 'eq', 'not', 'nin' and 'in'.","format":"string","in":"query"},{"name":"netStock","type":"integer","required":false,"description":"Filter restricts the result to variations which meet the specified net stock criteria. Allowed operators are: 'eq', 'lt', 'lte', 'gt' and 'gte'.","format":"integer","in":"query"},{"name":"physicalStock","type":"integer","required":false,"description":"Filter restricts the result to variations which meet the specified physical stock criteria. Allowed operators are: 'eq', 'lt', 'lte', 'gt' and 'gte'.","format":"integer","in":"query"},{"name":"itemNames","type":"string","required":false,"description":"Filter restricts the list of results to variations matching any name of the item.","format":"string","in":"query"},{"name":"itemName1","type":"string","required":false,"description":"Filter restricts the list of results to variations matching name 1 of the item","format":"string","in":"query"},{"name":"itemName2","type":"string","required":false,"description":"Filter restricts the list of results to variations matching name 2 of the item.","format":"string","in":"query"},{"name":"itemName3","type":"string","required":false,"description":"Filter restricts the list of results to variations matching name 3 of the item.","format":"string","in":"query"},{"name":"number","type":"string","required":false,"description":"Filter restricts the list of results to variations which matching the number of the variation.","format":"string","in":"query"},{"name":"model","type":"string","required":false,"description":"Filter restricts the list of results to variations which matching the model of the variation.","format":"string","in":"query"},{"name":"supplierItemNumber","type":"string","required":false,"description":"Filter restricts the list of results to variations which matching the supplier item number of the variation.","format":"string","in":"query"},{"name":"lang","type":"string","required":false,"description":"Specifies the language of the language-dependent filters","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":"barcodeUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose barcodes 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":"categoryUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose categories 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":"clientUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose clients 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":"marketUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose markets 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":"propertyUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose properties 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":"salesPriceUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose sales prices 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":"supplierUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose suppliers 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":"tagUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose tags 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":"warehouseUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose warehouse 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":"relatedUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose relations (any) has been updated in the specified time frame. The from and to parameter should be separated by a coma. If there is no to value, The current time is used instead.","format":"string","in":"query"},{"name":"stockLimitation","type":"string","required":false,"description":"Filter restricts the list of results to variations which meet the specified stock limitation criteria.","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"},{"name":"hasLowestPrice","type":"boolean","required":false,"description":"Filter restricts the list of results to variations which has or has not lowest price.","format":"boolean","in":"query"}]},"put":{"summary":"Create a list of variations and their related data","description":"Creates a list of variations and their related data.","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."}},"parameters":[{"in":"body","name":"\/rest\/pim\/variations","schema":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the variation. optional"},"additionalSkus":{"type":"array","items":{"$ref":"#\/definitions\/AdditionalSku"}},"attributeValues":{"type":"array","items":{"$ref":"#\/definitions\/AttributeValue"}},"barcodes":{"type":"array","items":{"$ref":"#\/definitions\/Barcode"}},"bundleComponents":{"type":"array","items":{"$ref":"#\/definitions\/BundleComponent"}},"categories":{"type":"array","items":{"$ref":"#\/definitions\/Category"}},"clients":{"type":"array","items":{"$ref":"#\/definitions\/Client"}},"defaultCategories":{"type":"array","items":{"$ref":"#\/definitions\/DefaultCategory"}},"images":{"type":"array","items":{"$ref":"#\/definitions\/Image"}},"markets":{"type":"array","items":{"$ref":"#\/definitions\/Market"}},"marketIdentNumbers":{"type":"array","items":{"$ref":"#\/definitions\/MarketIdentNumber"}},"salesPrices":{"type":"array","items":{"$ref":"#\/definitions\/SalesPrice"}},"skus":{"type":"array","items":{"$ref":"#\/definitions\/Sku"}},"supplier":{"type":"array","items":{"$ref":"#\/definitions\/Supplier"}},"warehouses":{"type":"array","items":{"$ref":"#\/definitions\/Warehouse"}},"properties":{"type":"array","items":{"$ref":"#\/definitions\/Property"}},"tags":{"type":"array","items":{"$ref":"#\/definitions\/Tag"}},"comments":{"type":"array","items":{"$ref":"#\/definitions\/Comment"}},"inheritance":{"type":"array","items":{"$ref":"#\/definitions\/Inheritance"}},"unit":{"type":"array","items":{"$ref":"#\/definitions\/Unit"}},"base":{"type":"array","items":{"$ref":"#\/definitions\/Base"}}}}}]}},"\/rest\/pim\/variations\/additional_skus":{"delete":{"summary":"Delete a list of variation additional skus","description":"Deletes a list of variation additional skus.","tags":["Pim"],"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."}}},"put":{"summary":"Create and update variation additional skus","description":"Creates and updates a list of variation additional skus.","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\/variations\/barcodes":{"delete":{"summary":"Delete variation barcodes","description":"Deletes a list of variation barcodes.","tags":["Pim"],"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."}}},"put":{"summary":"Create and update a list of variation barcodes","description":"Creates and updates a list of variation barcodes.","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\/variations\/bases":{"put":{"summary":"Create and update a list of variations","description":"Creates and updates a list of variations.","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\/variations\/bundle_components":{"delete":{"summary":"Delete variation bundle components","description":"Deletes a list of variation bundle components.","tags":["Pim"],"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."}}},"put":{"summary":"Create and update a list of variation bundle components","description":"Creates and updates a list of variation bundle components.","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\/variations\/categories":{"delete":{"summary":"Delete variation categories","description":"Deletes a list of variation categories.","tags":["Pim"],"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."}}},"put":{"summary":"Create and update a list of variation categories","description":"Creates and updates a list of variation categories.","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\/variations\/clients":{"delete":{"summary":"Delete a list of variation clients","description":"Deletes a list of variation clients.","tags":["Pim"],"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."}}},"put":{"summary":"Create a list of variation clients","description":"Creates a list of variation clients.","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\/variations\/comments":{"delete":{"summary":"Delete variation comments","description":"Deletes a list of variation comments.","tags":["Pim"],"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."}}},"put":{"summary":"Create and update a list of variation comments","description":"Creates and updates a list of variation comments.","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\/variations\/default_categories":{"delete":{"summary":"Delete variation default categories","description":"Deletes a list of variation default categories.","tags":["Pim"],"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."}}},"put":{"summary":"Create and update a list of variation default categories","description":"Creates and updates a list of variation default categories.","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\/variations\/images":{"delete":{"summary":"Delete variation images","description":"Deletes a list of variation images.","tags":["Pim"],"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."}}},"put":{"summary":"Create a list of variation images","description":"Creates a list of variation images.","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\/variations\/market_ident_numbers":{"delete":{"summary":"Delete a list of variation market ident numbers","description":"Deletes a list of variation market ident numbers.","tags":["Pim"],"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."}}},"put":{"summary":"Create and update a list of variation market ident numbers","description":"Creates and updates a list of variation market ident numbers.","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\/variations\/markets":{"delete":{"summary":"Delete a list of variation markets","description":"Deletes a list of variation markets.","tags":["Pim"],"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."}}},"put":{"summary":"Create a list of variation markets","description":"Creates a list of variation markets.","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\/variations\/properties":{"delete":{"summary":"Delete a list of variation properties","description":"Deletes a list of variation properties.","tags":["Pim"],"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."}}},"put":{"summary":"Create and update a list of variation properties","description":"Creates and updates a list of variation properties.","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\/variations\/sales_prices":{"delete":{"summary":"Delete a list of variation sales prices","description":"Deletes a list of variation sales prices.","tags":["Pim"],"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."}}},"put":{"summary":"Create and update a list of variation sales prices","description":"Creates and updates a list of variation sales prices.","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\/variations\/scroll":{"get":{"summary":"Get all variations, scrolled by a cursor","description":"Get all variations, with the specified data, scrolled by a cursor","tags":["Pim"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/CursorResult"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'additionalSkus' = The additional skus of the variation.<\/li><li>'attributeValues' = The attribute values of the variation.<\/li><li>'attributeValues.attribute'\/b> = Includes attributeValues. The attribute data to the related attribute ID.<\/li><li>'attributeValues.attributeValue' = Includes attributeValues. The attribute value data to the related attribute value ID.<\/li><li>'barcodes' = The barcodes of the variation.<\/li><li>'barcodes.barcode' = Includes barcodes. The barcode data to the related barcode ID.<\/li><li>'base' = The variation base.<\/li><li>'base.item' = Includes base. The item data of the variation.<\/li><li>'base.itemSerialNumber' = Includes base. The item serial numbers of the variation.<\/li><li>'base.feedback' = Includes base. The feedback of the variation.<\/li><li>'base.characteristics' = Includes base. The characteristics of the variation.<\/li><li>'base.crossSelling' = Includes base. The cross selling items of the variation.<\/li><li>'base.texts' = Includes base. The texts of the variation.<\/li><li>'base.availability' = Includes base. The availability data related to the variation's availability ID.<\/li><li>'base.images' = Includes base. The images linked to the item.<\/li><li>'base.shippingProfiles' = Includes base. The shipping profiles linked to the item.<\/li><li>'base.stock' = Includes base. The stock of the variation.<\/li><li>'base.stockStorageLocations' = Includes base. The stock storage locations of the variation.<\/li><li>'bundleComponents' = The bundle components of the variation.<\/li><li>'categories' = The categories of the variation.<\/li><li>'categories.category' = Includes categories. The related category data for each category ID.<\/li><li>'categories.categoryBranch' = Includes categories. The related category branch data for each category ID.<\/li><li>'clients' = The clients of the variation.<\/li><li>'defaultCategories' = The default categories of the variation<\/li><li>'defaultCategories.category' = Includes defaultCategories. The category data to the related category ID.<\/li><li>'images' = The images of the variation<\/li><li>'images.image' = Includes images. The image data to the related image ID.<\/li><li>'markets' = The markets of the variation.<\/li><li>'marketIdentNumbers' = The market ident numbers of the variation<\/li><li>'salesPrices' = The sales prices of the variation.<\/li><li>'salesPrices.salesPrice' = Includes salesPrices. The sales price data to the related sales price ID.<\/li><li>'skus' = The skus of the variation.<\/li><li>'supplier' = The supplier of the variation.<\/li><li>'supplier.supplier' = Includes supplier. The contact data to the related supplier ID.<\/li><li>'timestamps' = The timetamps of the variation.<\/li><li>'warehouses' = The warehouses of the variation<\/li><li>'warehouses.warehouse' = Includes warehouses. The warehouse data to the related warehouse ID.<\/li><li>'unit' = The unit of the variation<\/li><li>'unit.unit' = Includes unit. The unit data of the related unit ID.<\/li><li>'tags' = The tags of the variation.<\/li><li>'tags.tag' = Includes tags. The tag data to the related tag ID.<\/li><li>'properties' = The properties of the variation.<\/li><li>'properties.property' = Includes properties. The property data to the related property ID.<\/li><li>'comments' = The comments of the variation.<\/li><li>'inheritance' = The inheritance of the variation.<\/li><\/ul>","format":"string","in":"query"},{"name":"groupBy","type":"string","required":false,"description":"Groups the result. The following parameters are available:<ul><li>'itemId' = Groups the result by the item ID.<\/li><li>'itemAttributeValue' = Groups the result by the attribute with the flag 'isGroupable'.<\/li><\/ul>","format":"string","in":"query"},{"name":"query","type":"string","required":false,"description":"Filter restricts the list of results to variations matching the specified query","format":"string","in":"query"},{"name":"itemId","type":"integer","required":false,"description":"Filter restricts the list of results to variations with the specified item ID. Limited to 100 ids","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":"hasBarcode","type":"boolean","required":false,"description":"Filter restricts the list of results to variations which have at least one barcode (true) or have no barcodes (false).","format":"boolean","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":"number","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":"hasListing","type":"boolean","required":false,"description":"Filter restricts the list of results to variations which have at least one or no listing.","format":"boolean","in":"query"},{"name":"marketId","type":"number","required":false,"description":"Filter restricts the list of results to variations which have the specified market ID.","format":"number","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":"referrerIds","type":"string","required":false,"description":"Filter restricts the list of results to variations which have\/not 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 result to variations which have a price for the given sales price ID within the specified range. Price ID, from and to value should be separated by a semicolon. Multiple IDs are separated by comma. Allowed comparators: none.","format":"string","in":"query"},{"name":"priceCalculationUuid","type":"string","required":false,"description":"Filter restricts the result to variations which have a price for the given sales price calculation uuid. Allowed comparators: 'eq'","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":"propertyId","type":"string","required":false,"description":"Filter restricts the list of results based on property IDs. Use 'in:' or 'nin:' prefix followed by comma-separated IDs (e.g., 'in:3,4,5' or 'nin:2,5,6'). Allowed operators: 'in', 'nin'.","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. Allowed operators: 'eq'.","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. Multiple IDs are separated by commas. Allowed operators: 'in'.","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. Multiple IDs are separated by commas. Allowed operators: 'all'.","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":"bundleComponentVariationId","type":"integer","required":false,"description":"Filter restricts the list of results to variations which have the specified bundle component variation ID.","format":"integer","in":"query"},{"name":"itemNames","type":"string","required":false,"description":"Filter restricts the list of results to variations matching any name of the item.","format":"string","in":"query"},{"name":"itemName1","type":"string","required":false,"description":"Filter restricts the list of results to variations matching name 1 of the item","format":"string","in":"query"},{"name":"itemName2","type":"string","required":false,"description":"Filter restricts the list of results to variations matching name 2 of the item.","format":"string","in":"query"},{"name":"itemName3","type":"string","required":false,"description":"Filter restricts the list of results to variations matching name 3 of the item.","format":"string","in":"query"},{"name":"number","type":"string","required":false,"description":"Filter restricts the list of results to variations which matching the number of the variation.","format":"string","in":"query"},{"name":"model","type":"string","required":false,"description":"Filter restricts the list of results to variations which matching the model of the variation.","format":"string","in":"query"},{"name":"supplierItemNumber","type":"string","required":false,"description":"Filter restricts the list of results to variations which matching the supplier item number of the variation.","format":"string","in":"query"},{"name":"lang","type":"string","required":false,"description":"Specifies the language of the language-dependent filters","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":"barcodeUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose barcodes 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":"categoryUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose categories 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":"clientUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose clients 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":"marketUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose markets 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":"propertyUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose properties 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":"supplierUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose suppliers 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":"tagUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose tags 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":"warehouseUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose warehouse 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":"relatedUpdatedAt","type":"string","required":false,"description":"Filter restricts the list of results to variations whose relations (any) has been updated in the specified time frame. The from and to parameter should be separated by a coma. If there is no to value, The current time is used instead.","format":"string","in":"query"},{"name":"hasLowestPrice","type":"boolean","required":false,"description":"Filter restricts the list of results to variations which has or has not lowest price.","format":"boolean","in":"query"},{"name":"stockLimitation","type":"string","required":false,"description":"Filter restricts the list of results to variations which meet the specified stock limitation criteria.","format":"string","in":"query"},{"name":"cursor","type":"string","required":false,"description":"The cursor to get the next entries","format":"string","in":"query"}]}},"\/rest\/pim\/variations\/skus":{"delete":{"summary":"Delete a list of variation skus","description":"Deletes a list of variation skus.","tags":["Pim"],"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."}}},"put":{"summary":"Create and update a list of variation skus","description":"Creates and updates a list of variation skus.","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\/variations\/supplier":{"delete":{"summary":"Delete a list of variation supplier","description":"Deletes a list of variation supplier.","tags":["Pim"],"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."}}},"put":{"summary":"Create and update a list of variation suppliers","description":"Creates and updates a list of variation suppliers.","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\/variations\/tags":{"delete":{"summary":"Delete a list of variation tags","description":"Deletes a list of variation tags.","tags":["Pim"],"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."}}},"put":{"summary":"Create a list of variation tags","description":"Creates a list of variation tags.","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\/variations\/warehouses":{"delete":{"summary":"Delete a list of variation warehouses","description":"Deletes a list of variation warehouses.","tags":["Pim"],"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."}}},"put":{"summary":"Create and update a list of variation warehouses","description":"Creates and updates a list of variation warehouses.","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\/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"}},"examples":{"application\/json":[{"name":"iure","hash":"MWxONTc"},{"name":"numquam","hash":"MUh7NTc"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"name":"vel","hash":"WzE1Ozc"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},{"in":"body","name":"\/rest\/plugin_sets","schema":{"type":"object","properties":{"name":{"type":"string","description":"optional matching to \/^[a-zA-Z0-9\\ \\-_.:\u00e4\u00c4\u00f6\u00d6\u00fc\u00dc\u00df]{3,255}$\/"},"description":{"type":"string","description":"optional matching to \/^[a-zA-Z0-9\\ \\-_.:\u00e4\u00c4\u00f6\u00d6\u00fc\u00dc\u00df]{3,512}$\/"}}}}]}},"\/rest\/plugin_sets\/info":{"get":{"summary":"Get details about plugin sets","description":"Get details about plugin sets (count, limits)","tags":["PluginSet"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PluginSetsInfo"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/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":"Get open source plugins from inbox","description":"Gets all the open source plugins from the Inbox.","tags":["PluginSet"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PluginSet"}},"examples":{"application\/json":[{"name":"ut","hash":"MUVkNTc"},{"name":"voluptates","hash":"alcxNTc"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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":{"$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":"$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\/upload_translations":{"post":{"summary":"Uploads and syncs resources","description":"Uploads to S3 and synchronizes language resources","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":"","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":{"$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":"$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\/{pluginSetId}\/updateReversedDependencies":{"get":{"summary":"Update reversed dependencies","description":"Updates the dependencies that's needed for the plugin","tags":["Plugins"],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/mixed"}}},"parameters":[{"name":"pluginSetId","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":"Gets a set based on its ID.","tags":["PluginSet"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PluginSet"},"examples":{"application\/json":{"name":"vel","hash":"UlYxNTc"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},{"in":"body","name":"\/rest\/plugin_sets\/{setId}","schema":{"type":"object","properties":{"name":{"type":"string","description":"optional matching to \/^[a-zA-Z0-9\\ \\-_.:\u00e4\u00c4\u00f6\u00d6\u00fc\u00dc\u00df]{3,255}$\/"},"description":{"type":"string","description":"optional matching to \/^[a-zA-Z0-9\\ \\-_.:\u00e4\u00c4\u00f6\u00d6\u00fc\u00dc\u00df]{3,512}$\/"}}}}]}},"\/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":"Get plugin compatibility","description":"Checks if the plugin is compatible, based on its requirements.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"name":"OKonMayertAndGoldnersPlugin","activeStage":false,"activeProductive":false,"position":1,"inProductive":false,"inStage":false,"type":"export","version":"0.0.0","description":"","namespace":"","author":"","keywords":[],"require":[],"platform":[],"runOnBuild":[],"checkOnBuild":[],"authorIcon":"","pluginIcon":"","isConnectedWithGit":false,"isInstalledWithGit":false,"dependencies":[],"javaScriptFiles":[],"containers":[],"dataProviders":[],"source":"local","updateInformation":{"hasUpdate":false,"updateVariationId":null,"updateVersion":null},"isClosedSource":false,"license":"","shortDescription":{"de":"","en":""},"categories":[],"price":0,"email":"","phone":"","marketplaceName":{"de":"","en":""},"subscriptionInformation":[],"versionStage":"","versionProductive":"","marketplaceVariations":[],"webhookUrl":"","isExternalTool":false,"directDownloadLinks":[],"forwardLink":"","notInstalledRequirements":[],"notActiveStageRequirements":[],"notActiveProductiveRequirements":[],"pluginSetIds":[],"installed":null,"branch":null,"commit":null,"repository":null,"installedPlugins":null,"pluginSetEntries":[]},{"name":"CummingsStiedemannsPlugin","activeStage":false,"activeProductive":false,"position":1,"inProductive":false,"inStage":false,"type":"design","version":"0.0.0","description":"","namespace":"","author":"","keywords":[],"require":[],"platform":[],"runOnBuild":[],"checkOnBuild":[],"authorIcon":"","pluginIcon":"","isConnectedWithGit":false,"isInstalledWithGit":false,"dependencies":[],"javaScriptFiles":[],"containers":[],"dataProviders":[],"source":"local","updateInformation":{"hasUpdate":false,"updateVariationId":null,"updateVersion":null},"isClosedSource":false,"license":"","shortDescription":{"de":"","en":""},"categories":[],"price":0,"email":"","phone":"","marketplaceName":{"de":"","en":""},"subscriptionInformation":[],"versionStage":"","versionProductive":"","marketplaceVariations":[],"webhookUrl":"","isExternalTool":false,"directDownloadLinks":[],"forwardLink":"","notInstalledRequirements":[],"notActiveStageRequirements":[],"notActiveProductiveRequirements":[],"pluginSetIds":[],"installed":null,"branch":null,"commit":null,"repository":null,"installedPlugins":null,"pluginSetEntries":[]}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"Adds a plugin to the set based on its ID and the plugin set's ID.","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":"Activates \/ deactivates a plugin for a set by trashing or restoring the respective set entry. Both the plugin set's ID and the plugin's ID must be provided","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":"Changes the position of a plugin in a set.","tags":["PluginSet"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PluginSetEntry"},"examples":{"application\/json":{"pluginId":8,"pluginSetId":5}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"Lists all the SetEntries of a specific set based on its ID.","tags":["PluginSet"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PluginSetEntry"}},"examples":{"application\/json":[{"pluginId":4,"pluginSetId":3},{"pluginId":3,"pluginSetId":6}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"Gets info about a git plugin based on the plugin name.","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":"Gets info about the plugin, based on the plugin name.","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"}},"examples":{"application\/json":[{"name":"DickiPourossPlugin","activeStage":false,"activeProductive":false,"position":8,"inProductive":false,"inStage":false,"type":"export","version":"0.0.0","description":"","namespace":"","author":"","keywords":[],"require":[],"platform":[],"runOnBuild":[],"checkOnBuild":[],"authorIcon":"","pluginIcon":"","isConnectedWithGit":false,"isInstalledWithGit":false,"dependencies":[],"javaScriptFiles":[],"containers":[],"dataProviders":[],"source":"local","updateInformation":{"hasUpdate":false,"updateVariationId":null,"updateVersion":null},"isClosedSource":false,"license":"","shortDescription":{"de":"","en":""},"categories":[],"price":0,"email":"","phone":"","marketplaceName":{"de":"","en":""},"subscriptionInformation":[],"versionStage":"","versionProductive":"","marketplaceVariations":[],"webhookUrl":"","isExternalTool":false,"directDownloadLinks":[],"forwardLink":"","notInstalledRequirements":[],"notActiveStageRequirements":[],"notActiveProductiveRequirements":[],"pluginSetIds":[],"installed":null,"branch":null,"commit":null,"repository":null,"installedPlugins":null,"pluginSetEntries":[]},{"name":"RolfsonPLCsPlugin","activeStage":false,"activeProductive":false,"position":1,"inProductive":false,"inStage":false,"type":"design","version":"0.0.0","description":"","namespace":"","author":"","keywords":[],"require":[],"platform":[],"runOnBuild":[],"checkOnBuild":[],"authorIcon":"","pluginIcon":"","isConnectedWithGit":false,"isInstalledWithGit":false,"dependencies":[],"javaScriptFiles":[],"containers":[],"dataProviders":[],"source":"local","updateInformation":{"hasUpdate":false,"updateVariationId":null,"updateVersion":null},"isClosedSource":false,"license":"","shortDescription":{"de":"","en":""},"categories":[],"price":0,"email":"","phone":"","marketplaceName":{"de":"","en":""},"subscriptionInformation":[],"versionStage":"","versionProductive":"","marketplaceVariations":[],"webhookUrl":"","isExternalTool":false,"directDownloadLinks":[],"forwardLink":"","notInstalledRequirements":[],"notActiveStageRequirements":[],"notActiveProductiveRequirements":[],"pluginSetIds":[],"installed":null,"branch":null,"commit":null,"repository":null,"installedPlugins":null,"pluginSetEntries":[]}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"name":"DAmorePLCsPlugin","activeStage":false,"activeProductive":false,"position":2,"inProductive":false,"inStage":false,"type":"export","version":"0.0.0","description":"","namespace":"","author":"","keywords":[],"require":[],"platform":[],"runOnBuild":[],"checkOnBuild":[],"authorIcon":"","pluginIcon":"","isConnectedWithGit":false,"isInstalledWithGit":false,"dependencies":[],"javaScriptFiles":[],"containers":[],"dataProviders":[],"source":"local","updateInformation":{"hasUpdate":false,"updateVariationId":null,"updateVersion":null},"isClosedSource":false,"license":"","shortDescription":{"de":"","en":""},"categories":[],"price":0,"email":"","phone":"","marketplaceName":{"de":"","en":""},"subscriptionInformation":[],"versionStage":"","versionProductive":"","marketplaceVariations":[],"webhookUrl":"","isExternalTool":false,"directDownloadLinks":[],"forwardLink":"","notInstalledRequirements":[],"notActiveStageRequirements":[],"notActiveProductiveRequirements":[],"pluginSetIds":[],"installed":null,"branch":null,"commit":null,"repository":null,"installedPlugins":null,"pluginSetEntries":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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\/constraint\/version":{"post":{"summary":"Checks for version constraint","description":"Checks if the plugin is compatible with the requirements","tags":["Plugins"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}}}}}},"\/rest\/plugins\/plugin_sets\/{pluginSetId}\/configurations\/export":{"get":{"summary":"Exports a configuration file","description":"Returns a json of the configuration from a specific plugin and plugin set","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":"Imports a configuration file","description":"Imports a previously exported configuration file for a specific plugin and plugin set.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"name":"OkunevaGoodwinAndBayersPlugin","activeStage":false,"activeProductive":false,"position":9,"inProductive":false,"inStage":false,"type":"design","version":"0.0.0","description":"","namespace":"","author":"","keywords":[],"require":[],"platform":[],"runOnBuild":[],"checkOnBuild":[],"authorIcon":"","pluginIcon":"","isConnectedWithGit":false,"isInstalledWithGit":false,"dependencies":[],"javaScriptFiles":[],"containers":[],"dataProviders":[],"source":"local","updateInformation":{"hasUpdate":false,"updateVariationId":null,"updateVersion":null},"isClosedSource":false,"license":"","shortDescription":{"de":"","en":""},"categories":[],"price":0,"email":"","phone":"","marketplaceName":{"de":"","en":""},"subscriptionInformation":[],"versionStage":"","versionProductive":"","marketplaceVariations":[],"webhookUrl":"","isExternalTool":false,"directDownloadLinks":[],"forwardLink":"","notInstalledRequirements":[],"notActiveStageRequirements":[],"notActiveProductiveRequirements":[],"pluginSetIds":[],"installed":null,"branch":null,"commit":null,"repository":null,"installedPlugins":null,"pluginSetEntries":[]},{"name":"MayertSimonisAndErdmansPlugin","activeStage":false,"activeProductive":false,"position":4,"inProductive":false,"inStage":false,"type":"export","version":"0.0.0","description":"","namespace":"","author":"","keywords":[],"require":[],"platform":[],"runOnBuild":[],"checkOnBuild":[],"authorIcon":"","pluginIcon":"","isConnectedWithGit":false,"isInstalledWithGit":false,"dependencies":[],"javaScriptFiles":[],"containers":[],"dataProviders":[],"source":"local","updateInformation":{"hasUpdate":false,"updateVariationId":null,"updateVersion":null},"isClosedSource":false,"license":"","shortDescription":{"de":"","en":""},"categories":[],"price":0,"email":"","phone":"","marketplaceName":{"de":"","en":""},"subscriptionInformation":[],"versionStage":"","versionProductive":"","marketplaceVariations":[],"webhookUrl":"","isExternalTool":false,"directDownloadLinks":[],"forwardLink":"","notInstalledRequirements":[],"notActiveStageRequirements":[],"notActiveProductiveRequirements":[],"pluginSetIds":[],"installed":null,"branch":null,"commit":null,"repository":null,"installedPlugins":null,"pluginSetEntries":[]}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/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"}},"examples":{"application\/json":{"item":{"pattern":"\/{itemId}_{variationId?}","container":""},"contentCategory":[],"itemCategory":[],"blog":[]}}}}}},"\/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"}},"examples":{"application\/json":[{"name":"EichmannLemkesPlugin","activeStage":false,"activeProductive":false,"position":3,"inProductive":false,"inStage":false,"type":"export","version":"0.0.0","description":"","namespace":"","author":"","keywords":[],"require":[],"platform":[],"runOnBuild":[],"checkOnBuild":[],"authorIcon":"","pluginIcon":"","isConnectedWithGit":false,"isInstalledWithGit":false,"dependencies":[],"javaScriptFiles":[],"containers":[],"dataProviders":[],"source":"local","updateInformation":{"hasUpdate":false,"updateVariationId":null,"updateVersion":null},"isClosedSource":false,"license":"","shortDescription":{"de":"","en":""},"categories":[],"price":0,"email":"","phone":"","marketplaceName":{"de":"","en":""},"subscriptionInformation":[],"versionStage":"","versionProductive":"","marketplaceVariations":[],"webhookUrl":"","isExternalTool":false,"directDownloadLinks":[],"forwardLink":"","notInstalledRequirements":[],"notActiveStageRequirements":[],"notActiveProductiveRequirements":[],"pluginSetIds":[],"installed":null,"branch":null,"commit":null,"repository":null,"installedPlugins":null,"pluginSetEntries":[]},{"name":"PredovicSteubersPlugin","activeStage":false,"activeProductive":false,"position":4,"inProductive":false,"inStage":false,"type":"export","version":"0.0.0","description":"","namespace":"","author":"","keywords":[],"require":[],"platform":[],"runOnBuild":[],"checkOnBuild":[],"authorIcon":"","pluginIcon":"","isConnectedWithGit":false,"isInstalledWithGit":false,"dependencies":[],"javaScriptFiles":[],"containers":[],"dataProviders":[],"source":"local","updateInformation":{"hasUpdate":false,"updateVariationId":null,"updateVersion":null},"isClosedSource":false,"license":"","shortDescription":{"de":"","en":""},"categories":[],"price":0,"email":"","phone":"","marketplaceName":{"de":"","en":""},"subscriptionInformation":[],"versionStage":"","versionProductive":"","marketplaceVariations":[],"webhookUrl":"","isExternalTool":false,"directDownloadLinks":[],"forwardLink":"","notInstalledRequirements":[],"notActiveStageRequirements":[],"notActiveProductiveRequirements":[],"pluginSetIds":[],"installed":null,"branch":null,"commit":null,"repository":null,"installedPlugins":null,"pluginSetEntries":[]}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"name":"ParkerSchadensPlugin","activeStage":false,"activeProductive":false,"position":1,"inProductive":false,"inStage":false,"type":"design","version":"0.0.0","description":"","namespace":"","author":"","keywords":[],"require":[],"platform":[],"runOnBuild":[],"checkOnBuild":[],"authorIcon":"","pluginIcon":"","isConnectedWithGit":false,"isInstalledWithGit":false,"dependencies":[],"javaScriptFiles":[],"containers":[],"dataProviders":[],"source":"local","updateInformation":{"hasUpdate":false,"updateVariationId":null,"updateVersion":null},"isClosedSource":false,"license":"","shortDescription":{"de":"","en":""},"categories":[],"price":0,"email":"","phone":"","marketplaceName":{"de":"","en":""},"subscriptionInformation":[],"versionStage":"","versionProductive":"","marketplaceVariations":[],"webhookUrl":"","isExternalTool":false,"directDownloadLinks":[],"forwardLink":"","notInstalledRequirements":[],"notActiveStageRequirements":[],"notActiveProductiveRequirements":[],"pluginSetIds":[],"installed":null,"branch":null,"commit":null,"repository":null,"installedPlugins":null,"pluginSetEntries":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"name":"JerdeBoyleAndHerzogsPlugin","activeStage":false,"activeProductive":false,"position":3,"inProductive":false,"inStage":false,"type":"design","version":"0.0.0","description":"","namespace":"","author":"","keywords":[],"require":[],"platform":[],"runOnBuild":[],"checkOnBuild":[],"authorIcon":"","pluginIcon":"","isConnectedWithGit":false,"isInstalledWithGit":false,"dependencies":[],"javaScriptFiles":[],"containers":[],"dataProviders":[],"source":"local","updateInformation":{"hasUpdate":false,"updateVariationId":null,"updateVersion":null},"isClosedSource":false,"license":"","shortDescription":{"de":"","en":""},"categories":[],"price":0,"email":"","phone":"","marketplaceName":{"de":"","en":""},"subscriptionInformation":[],"versionStage":"","versionProductive":"","marketplaceVariations":[],"webhookUrl":"","isExternalTool":false,"directDownloadLinks":[],"forwardLink":"","notInstalledRequirements":[],"notActiveStageRequirements":[],"notActiveProductiveRequirements":[],"pluginSetIds":[],"installed":null,"branch":null,"commit":null,"repository":null,"installedPlugins":null,"pluginSetEntries":[]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"Get configuration file","description":"Gets the configuration file for a specific plugin based on its ID and plugin set.","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":"List configurations","description":"Loads detailed configuration of a plugin based on its ID and plugin set ID.","tags":["Configuration"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/Configuration"}},"examples":{"application\/json":[{"key":"temporibus.dolores","plugin_id":3,"value":"http:\/\/www.reynolds.info\/fugiat-repudiandae-eum-est-voluptate.html","pluginSetEntryId":1,"label":[],"type":"","possibleValues":[],"default":null,"tab":null,"scss":false},{"key":"autem.aut","plugin_id":5,"value":"http:\/\/www.bergstrom.com\/voluptatum-nesciunt-occaecati-doloribus-tenetur-eum","pluginSetEntryId":6,"label":[],"type":"","possibleValues":[],"default":null,"tab":null,"scss":false}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"Save configuration file","description":"Saves the configuration file for a specific plugin based on its ID and the plugin set.","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\/{pluginId}\/plugin_sets\/{pluginSetId}\/containers":{"get":{"summary":"List containers","description":"Lists all containers of plugins in a 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":"pluginId","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"name":"pluginSetId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/plugins\/{pluginName}\/plugin_sets\/{pluginSetId}\/reversedDependencies":{"post":{"summary":"Get reversed requirements","description":"Gets the requirements based on the plugin name and the plugin set ID.","tags":["Plugins"],"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":"pluginName","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":"Sends a 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. Filters can be specified . Sort by argument can be specified. Sort order can be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/Property"}},"examples":{"application\/json":[{"cast":"date","typeIdentifier":"Cumque nihil qui cupiditate nemo dolor aut explicabo fuga.","position":4},{"cast":"file","typeIdentifier":"Qui eos et impedit doloribus fuga corrupti.","position":5}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"cast":"empty","typeIdentifier":"Esse sed nihil labore ab repellendus veniam accusantium laudantium vel.","position":4}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"}},"examples":{"application\/json":[{"platform":"Est eos.","category":"Optio non.","field":"Ullam."},{"platform":"Ea quisquam.","category":"Necessitatibus in.","field":"Aut."}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"platform":"Labore.","category":"Ut est.","field":"Provident distinctio."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"platform":"Quia.","category":"Nisi perspiciatis.","field":"Perspiciatis voluptatem."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"platform":"Dolores.","category":"Illum.","field":"Et amet."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"type":"type1","value":2},{"type":"type3","value":0}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"type":"type2","value":3}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"type":"type1","value":9}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"type":"type1","value":6}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"position":9},{"position":0}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"position":4}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","properties":{"position":{"type":"integer","description":"The position of the property group"}}}}]}},"\/rest\/properties\/groups\/names":{"get":{"summary":"List group names","description":"Lists group names. Filters like propertyGroupId and lang can be provided.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PropertyGroupName"}},"examples":{"application\/json":[{"lang":"Non suscipit.","name":"Nisi a et minima et necessitatibus."},{"lang":"Vero et.","name":"Nihil quos ut consectetur aut."}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"lang":"Rerum voluptas.","name":"Eum fugit qui beatae fugit."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"lang":"Neque aliquam et.","name":"Sit quis excepturi dolor alias ratione."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"lang":"Rerum totam.","name":"Sit et occaecati dolorum."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"groupOptionIdentifier":"Officiis debitis quod et et suscipit.","value":3},{"groupOptionIdentifier":"Ea alias et qui minima.","value":7}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"groupOptionIdentifier":"Est vitae dolores voluptas.","value":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"groupOptionIdentifier":"Maiores necessitatibus culpa distinctio autem ut.","value":4}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"groupOptionIdentifier":"Cum numquam ullam unde quia non nobis.","value":8}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"Gets surcharge types from module configuration.","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":"Gets group types from module configuration.","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"},"examples":{"application\/json":{"position":5}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"position":3}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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":"Mass attach property id and group id collection into the pivot table. GroupId 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"}]}},"\/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"}},"examples":{"application\/json":[{"referrerId":9,"referrerSubId":6,"value":"Harum velit repudiandae dolorem vel vel molestias quos placeat praesentium ipsum sit sint."},{"referrerId":9,"referrerSubId":5,"value":"Vel enim deleniti nobis est rem consequuntur molestiae ut sed nihil esse aut."}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"referrerId":5,"referrerSubId":5,"value":"Corporis labore perferendis et similique debitis tenetur."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"number","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","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"},"examples":{"application\/json":{"referrerId":6,"referrerSubId":2,"value":"Placeat velit praesentium et quia nisi vero reprehenderit totam aspernatur necessitatibus veritatis omnis et."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"referrerId":9,"referrerSubId":9,"value":"Tempore alias et sunt eum ducimus nobis soluta et odio iure praesentium."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"typeOptionIdentifier":"Eius saepe amet impedit qui recusandae temporibus velit cum qui voluptatem."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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. Filter like propertyId can be provided.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PropertyName"}},"examples":{"application\/json":[{"lang":"Occaecati labore.","name":"Debitis porro qui natus necessitatibus aliquam omnis modi fugiat.","description":"Alias aut quia est occaecati nemo expedita ex voluptatem ut velit omnis."},{"lang":"Iusto voluptatibus.","name":"Qui molestiae incidunt qui culpa sed et blanditiis et quia tempore commodi soluta.","description":"Qui aperiam est ea sit ipsam eos."}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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. The Property id , language, name must be provided.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyName"},"examples":{"application\/json":{"lang":"Aut et doloribus.","name":"Aliquam aut consequatur blanditiis nesciunt magnam dolore.","description":"A nulla quis laborum ipsum vero ut quia beatae qui accusamus et."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"lang":"Voluptatem enim.","name":"Id nihil placeat possimus dignissimos et ut molestiae.","description":"Nobis libero commodi aliquam natus illum voluptatem eius eum non et sit nihil."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"lang":"Tenetur sit similique.","name":"Possimus omnis provident consequatur magni cumque quia laudantium laborum illum.","description":"Autem fugiat qui veniam alias adipisci tenetur exercitationem qui ex quas consequatur."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"typeOptionIdentifier":"Quam dolorum iusto deleniti possimus consequatur placeat hic a et."},{"typeOptionIdentifier":"Non modi dolorum vero doloremque quod iure laborum."}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"typeOptionIdentifier":"Temporibus vitae pariatur velit labore et hic sapiente blanditiis."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"typeOptionIdentifier":"Non enim sit possimus dolor blanditiis occaecati consectetur mollitia."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"typeOptionIdentifier":"At repellat amet sunt excepturi itaque quas architecto quia assumenda iure optio."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"propertyId":9,"relationTypeIdentifier":"Nesciunt nulla quis quia et quia voluptate ut reprehenderit blanditiis hic.","relationTargetId":8,"selectionRelationId":null},{"propertyId":10,"relationTypeIdentifier":"Quos asperiores beatae ullam esse dolorem id doloremque.","relationTargetId":0,"selectionRelationId":null}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},{"name":"sortBy","type":"string","required":false,"description":"Filter sorts the result of property relations. 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:<ul><li>'propertyId'<\/li><li>'groupId'<\/li><li>'relationType'<\/li><\/ul>","format":"string","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"},"examples":{"application\/json":{"propertyId":11,"relationTypeIdentifier":"Qui et sed itaque ea natus neque et provident sequi vitae veritatis pariatur cumque.","relationTargetId":9,"selectionRelationId":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","properties":{"propertyId":{"type":"integer","description":"The ID of the property"},"selectionRelationId":{"type":"integer","description":"The ID of the selection relation optional"},"groupId":{"type":"integer","description":"The ID of the property group optional"},"markup":{"type":"number","description":"The mark up of the property relation optional"}}}}]},"put":{"summary":"Update relations","description":"Updates relations. The IDs of the properties relation must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelation"}},"examples":{"application\/json":[{"propertyId":13,"relationTypeIdentifier":"Perspiciatis dolor doloremque dolores et harum nisi sed reiciendis facilis nihil minus enim.","relationTargetId":7,"selectionRelationId":null},{"propertyId":14,"relationTypeIdentifier":"Voluptatem porro nobis qui itaque amet sint ad ad neque autem culpa laborum.","relationTargetId":5,"selectionRelationId":null}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/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"}},"examples":{"application\/json":[{"lang":"Dolores autem.","value":"Officiis at eum nemo sed voluptatum."},{"lang":"Ut ipsum est.","value":"Et placeat aspernatur qui fuga suscipit eos."}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"lang":"Sapiente sequi.","value":"Rerum cum sequi enim non minima."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"lang":"Sequi veniam quibusdam.","value":"Totam ut ullam inventore est."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"}]},"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"},"examples":{"application\/json":{"lang":"Minus delectus debitis.","value":"Eius quis officia architecto et."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"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"},"examples":{"application\/json":{"lang":"Iure temporibus explicabo.","value":"Blanditiis consequatur dignissimos deleniti reprehenderit autem."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/{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"},"examples":{"application\/json":{"propertyId":8,"relationTypeIdentifier":"Quibusdam animi quod ipsam consequatur autem architecto quae consequatur dolor repellat necessitatibus minus explicabo impedit.","relationTargetId":0,"selectionRelationId":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"propertyId":12,"relationTypeIdentifier":"Esse esse incidunt rerum vel velit occaecati tempore alias id voluptatem nisi molestias ut.","relationTargetId":6,"selectionRelationId":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"position":4},{"position":9}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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"},"examples":{"application\/json":{"position":6}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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"},"examples":{"application\/json":{"position":5}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"position":0}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"cast":"date","typeIdentifier":"Magnam molestiae ipsa et sit perferendis omnis commodi illo animi optio.","position":3}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"cast":"shortText","typeIdentifier":"Ut alias necessitatibus aut officiis vitae eveniet.","position":8}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"Quick login user","description":"Quick login user by client name and client secret","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"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":6,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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 optional allowed values are 15"},"orderItems":{"type":"array","items":{}},"relations":{"type":"array","items":{}}}}}]}},"\/rest\/redistributions\/preview":{"post":{"summary":"Get a redistribution create preview.","description":"Returns a redistribution preview for the given order data without creating a redistribution.","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\/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"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":5,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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 optional allowed values are 15"},"orderItems":{"type":"array","items":{}},"relations":{"type":"array","items":{}}}}}]}},"\/rest\/redistributions\/{orderId}\/book":{"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\/redistributions\/{orderId}\/preview":{"put":{"summary":"Get a redistribution update preview","description":"Returns a redistribution preview for the given order data without updating a redistribution. The order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/redistributions\/{orderId}\/split":{"post":{"summary":"Split a redistribution into at least two redistributions","description":"Splits a redistribution into at least two redistributions. The parent order ID and the quantities to use 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":"","format":"integer","in":"path"}]}},"\/rest\/redistributions\/{orderId}\/split_by_transactions":{"post":{"summary":"Split a redistribution into at least two redistributions by the order item transactions","description":"Splits a redistribution into at least two redistributions by the order item transactions. The parent order ID and the quantities to use 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":"","format":"integer","in":"path"}]}},"\/rest\/reorders":{"post":{"summary":"Create a reorder","description":"Creates a new reorder.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":8,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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 optional allowed values are 12"},"orderItems":{"type":"array","items":{}},"relations":{"type":"array","items":{}}}}}]}},"\/rest\/reorders\/group":{"post":{"summary":"Group multiple reorders in one reorder.","description":"Groups multiple reorders in one reorder. The IDs of the reorders to group must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":3,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/reorders\/items\/{orderItemId}\/assign_variation":{"post":{"summary":"Change an order item of type \"unassigned variation\" to \"variation\".","description":"Change an order item of type \"unassigned variation\" to \"variation\". The ID of the order item and variation ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":4,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/reorders\/items\/{orderItemId}\/unassign_variation":{"post":{"summary":"Change an order item of type \"variation\" to \"unassigned variation\".","description":"Change an order item of type \"variation\" to \"unassigned variation\". The ID of the order item must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":4,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/reorders\/preview":{"post":{"summary":"Get a reorder create preview.","description":"Returns a reorder preview for the given order data without creating a reorder.","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\/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"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":6,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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 optional allowed values are 12"},"orderItems":{"type":"array","items":{}},"relations":{"type":"array","items":{}}}}}]}},"\/rest\/reorders\/{orderId}\/book":{"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\/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"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":2,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":9,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"If given, this date is used and there is no date calculation.","format":"string","in":"query"},{"name":"transferToOrderItems","type":"string","required":false,"description":"Defines if the date should be transferred to the order items. Is only used when a date is given. Possible values: 'always', 'never', 'ifNotExists'.","format":"string","in":"query"}]}},"\/rest\/reorders\/{orderId}\/preview":{"put":{"summary":"Get a reorder update preview","description":"Returns a reorder preview for the given order data without updating a reorder. The order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/reorders\/{orderId}\/split":{"post":{"summary":"Split a reorder into at least two reorders","description":"Splits a reorder into at least two reorders. The parent order ID and the quantities to use 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":"","format":"integer","in":"path"}]}},"\/rest\/repairs":{"post":{"summary":"Create a repair","description":"Creates a repair.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":9,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/repairs\/items\/{orderItemId}\/assign_variation":{"post":{"summary":"Change an order item of type \"unassigned variation\" to \"variation\".","description":"Change an order item of type \"unassigned variation\" to \"variation\". The ID of the order item and variation ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":3,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/repairs\/items\/{orderItemId}\/unassign_variation":{"post":{"summary":"Change an order item of type \"variation\" to \"unassigned variation\".","description":"Change an order item of type \"variation\" to \"unassigned variation\". The ID of the order item must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":5,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/repairs\/preview":{"post":{"summary":"Get a repair order create preview.","description":"Returns a repair order preview for the given order data without creating a repair order.","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\/repairs\/reasons":{"get":{"summary":"Get all order repair reasons","description":"Gets all order repair reasons.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/RepairReason"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 an order repair reason","description":"Sets an order repair reason.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/RepairReason"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/repairs\/reasons\/{repairReasonId}":{"delete":{"summary":"Delete an order repair reason","description":"Deletes an order repair reason. The repair reason 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":"repairReasonId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get an order repair reason","description":"Gets an order repair reason. The repair reason has to be specified by providing a repair reason ID.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/RepairReason"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"repairReasonId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/repairs\/status":{"get":{"summary":"Get all order repair status","description":"Gets all order repair status.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/RepairStatus"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 an order repair status","description":"Sets an order repair status.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/RepairStatus"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/repairs\/status\/{repairStatusId}":{"delete":{"summary":"Delete an order repair status","description":"Deletes an order repair status. The repair status 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":"repairStatusId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get an order repair status","description":"Gets an order repair status. The repair status has to be specified by providing a repair status ID.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/RepairStatus"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"repairStatusId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/repairs\/{orderId}":{"delete":{"summary":"Delete a repair","description":"Deletes a repair. 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 repair","description":"Updates a repair. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":3,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/repairs\/{orderId}\/book":{"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","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"},{"in":"body","name":"\/rest\/repairs\/{orderId}\/book","schema":{"type":"object","properties":{"message":{"type":"string","description":""},"bookingDate":{"type":"string","description":""}}}}]}},"\/rest\/repairs\/{orderId}\/cancel_booking":{"post":{"summary":"Revert outgoing stock","description":"Cancellation the booking of an order. The ID of the order must be specified. With the array 'quantities' the items to cancel can be defined. If 'quantities' is not given, the whole order will be cancelled and the booking date will be deleted. If 'quantities' is defined, the booking date won't be reset.","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"},{"in":"body","name":"\/rest\/repairs\/{orderId}\/cancel_booking","schema":{"type":"object","properties":{"changeStatus":{"type":"boolean","description":""},"quantities":{"type":"array","items":{}}}}}]}},"\/rest\/repairs\/{orderId}\/cancel_booking\/validate":{"post":{"summary":"Validate cancellation of the booking of an order","description":"Validates cancellation of the booking 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\/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":"","format":"integer","in":"path"}]}},"\/rest\/repairs\/{orderId}\/preview":{"put":{"summary":"Get a repair order update preview","description":"Returns a repair order preview for the given order data without updating a repair order. The order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/repairs\/{orderId}\/restore":{"post":{"summary":"Restore a repair","description":"Restores a deleted repair. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":7,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/reports\/raw-data":{"get":{"summary":"Get list of raw data files.","description":"Get list of raw data files. Valid filter combinations: (dataName), (dataName & processStatus), (createdAtTimestamp)","tags":["BI"],"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":{"put":{"summary":"Resets all saved raw data configurations with given data","description":"Reset all raw data configurations and their children with provided data from the Request","tags":["BI"],"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":"array","required":true,"description":"Resets all saved raw data configurations with given configs","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/reports\/raw-data\/creators":{"get":{"summary":"Get list of all raw data creators","description":"returns list of raw data creators from plenty modules that were not set hidden (by default)","tags":["BI"],"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":"Returns list of paginated raw data creators with their configurations, by default itemsPerPage=50","tags":["BI"],"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":"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 raw data creators to be displayed per page. The default number of raw data creators per page is 50.","format":"integer","in":"query"}]}},"\/rest\/reports\/raw-data\/file":{"get":{"summary":"Get a raw data file from the storage","description":"Get a raw data file from the storage, the storage path of the file must be specified.","tags":["BI"],"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\/returns":{"post":{"summary":"Create a return","description":"Creates a return.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":9,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/returns\/items\/{orderItemId}\/assign_variation":{"post":{"summary":"Change an order item of type \"unassigned variation\" to \"variation\".","description":"Change an order item of type \"unassigned variation\" to \"variation\". The ID of the order item and variation ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":1,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/returns\/items\/{orderItemId}\/unassign_variation":{"post":{"summary":"Change an order item of type \"variation\" to \"unassigned variation\".","description":"Change an order item of type \"variation\" to \"unassigned variation\". The ID of the order item must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":1,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/returns\/preview":{"post":{"summary":"Get a return create preview.","description":"Returns a return preview for the given order data without creating a return.","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\/returns\/reasons":{"get":{"summary":"Get all order return reasons","description":"Gets all order return reasons.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/ReturnReason"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 an order return reason","description":"Sets an order return reason.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/ReturnReason"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/returns\/reasons\/{returnReasonsId}":{"delete":{"summary":"Delete an order return reason","description":"Deletes an order return reason. The return reason 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":"returnReasonsId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get an order return reason","description":"Gets an order return reason. The return reason has to be specified by providing a return reason ID.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ReturnReason"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"returnReasonsId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/returns\/status":{"get":{"summary":"Get all order return status","description":"Gets all order return status.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/ReturnStatus"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 an order return status","description":"Sets an order return status.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/ReturnStatus"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/returns\/status\/{returnStatusId}":{"delete":{"summary":"Delete an order return status","description":"Deletes an order return status. The return status 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":"returnStatusId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get an order return status","description":"Gets an order return status. The return status has to be specified by providing a return status ID.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ReturnStatus"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"returnStatusId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/returns\/{orderId}":{"delete":{"summary":"Delete a return","description":"Deletes a return. 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 return","description":"Updates a return. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":5,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/returns\/{orderId}\/book":{"post":{"summary":"Book order items of return","description":"Books order items of return. The parent order ID and the quantities to use 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"},{"in":"body","name":"\/rest\/returns\/{orderId}\/book","schema":{"type":"object","properties":{"quantities":{"type":"array","items":{}}}}}]}},"\/rest\/returns\/{orderId}\/book\/validate":{"post":{"summary":"Validate booking of an return","description":"Validates booking of an return. The ID of the order 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/returns\/{orderId}\/preview":{"put":{"summary":"Get a return update preview","description":"Returns a return preview for the given order data without updating a return. The order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/returns\/{orderId}\/restore":{"post":{"summary":"Restore a return","description":"Restores a deleted return. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":1,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/sales_orders":{"post":{"summary":"Create a sales order","description":"Creates a sales order.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":9,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/sales_orders\/group":{"post":{"summary":"Group multiple orders in one order.","description":"Groups multiple orders in one order. The IDs of the orders to group must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":5,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/sales_orders\/incomplete\/preview":{"post":{"summary":"Get a sales order create incomplete preview.","description":"Returns a sales order preview for the given incomplete order data without creating a sales order.","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\/sales_orders\/items\/{orderItemId}\/assign_variation":{"post":{"summary":"Change an order item of type \"unassigned variation\" to \"variation\".","description":"Change an order item of type \"unassigned variation\" to \"variation\". The ID of the order item and variation ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":9,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/sales_orders\/items\/{orderItemId}\/unassign_variation":{"post":{"summary":"Change an order item of type \"variation\" to \"unassigned variation\".","description":"Change an order item of type \"variation\" to \"unassigned variation\". The ID of the order item must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":9,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/sales_orders\/preview":{"post":{"summary":"Get a sales order create preview.","description":"Returns a sales order preview for the given order data without creating a sales order.","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\/sales_orders\/{orderId}":{"delete":{"summary":"Delete a sales order","description":"Deletes a sales order. 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 sales order","description":"Updates a sales order. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":2,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/sales_orders\/{orderId}\/book":{"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","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"},{"in":"body","name":"\/rest\/sales_orders\/{orderId}\/book","schema":{"type":"object","properties":{"message":{"type":"string","description":""},"bookingDate":{"type":"string","description":""}}}}]}},"\/rest\/sales_orders\/{orderId}\/cancel_booking":{"post":{"summary":"Revert outgoing stock","description":"Cancellation the booking of an order. The ID of the order must be specified. With the array 'quantities' the items to cancel can be defined. If 'quantities' is not given, the whole order will be cancelled and the booking date will be deleted. If 'quantities' is defined, the booking date won't be reset.","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"},{"in":"body","name":"\/rest\/sales_orders\/{orderId}\/cancel_booking","schema":{"type":"object","properties":{"changeStatus":{"type":"boolean","description":""},"quantities":{"type":"array","items":{}}}}}]}},"\/rest\/sales_orders\/{orderId}\/cancel_booking\/validate":{"post":{"summary":"Validate cancellation of the booking of an order","description":"Validates cancellation of the booking 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\/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":"","format":"integer","in":"path"}]}},"\/rest\/sales_orders\/{orderId}\/preview":{"put":{"summary":"Get a sales order update preview.","description":"Returns a sales order preview for the given order data without updating a sales order. The order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/sales_orders\/{orderId}\/restore":{"post":{"summary":"Restore a sales order","description":"Restores a deleted sales order. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":1,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/sales_orders\/{orderId}\/split":{"post":{"summary":"Split a sales order into at least two sales orders","description":"Splits a sales order into at least two sales orders. The parent order ID and the quantities to use 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":"","format":"integer","in":"path"}]}},"\/rest\/session_limits":{"get":{"summary":"Get session limits","description":"Get the limit of of concurrent sessions.","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\/shipping_center\/reset_shipments":{"delete":{"summary":"Reset a shipment","description":"Reset the shipments for the given order IDs. At least one ID of an 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":"orderIds","type":"array","required":true,"description":"The IDs of the orders that you want to reset the shipments for","format":"","in":"query","items":{"type":"integer"}}]}},"\/rest\/shop_builder\/content_links":{"get":{"summary":"List content links.","description":"List all content links for a given plugin set.","tags":["ShopBuilder"],"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.","description":"Link a content to a layout container of a frontend plugin.","tags":["ShopBuilder"],"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","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":["ShopBuilder"],"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":"Get a content link.","description":"Get a content link by ID.","tags":["ShopBuilder"],"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":["ShopBuilder"],"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","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":["ShopBuilder"],"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":["ShopBuilder"],"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":["ShopBuilder"],"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","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":"Mark contents to be regenerated. Active contents will be regenerated on next frontend request.\nInactive contents will be regenerated when opening them in the editor or after activating.","tags":["ShopBuilder"],"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":"containerName","type":"string","required":false,"description":"The ID of the plugin set to rebuild contents for.","format":"string","in":"query"},{"name":"pluginSetId","type":"integer","required":false,"description":"Layout container to regenerate contents for.","format":"integer","in":"query"}]}},"\/rest\/shop_builder\/contents\/search":{"get":{"summary":"Search for contents.","description":"Searches for specific contents based on the provided parameters.","tags":["ShopBuilder"],"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"},{"name":"contentLinkId","type":"integer","required":false,"description":"IDs of the related content link","format":"integer","in":"query"},{"name":"relatedContentType","type":"integer","required":false,"description":"Filter contents related to a specific type","format":"integer","in":"query"},{"name":"relatedContainerName","type":"integer","required":false,"description":"Filter contents related to a specific container","format":"integer","in":"query"}]}},"\/rest\/shop_builder\/contents\/{contentId}":{"delete":{"summary":"Delete a content.","description":"Deletes a ShopBuilder content.","tags":["ShopBuilder"],"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":"The ID of the content to delete.","format":"integer","in":"path"}]},"get":{"summary":"Find a content by ID.","description":"Finds a ShopBuilder content by its ID.","tags":["ShopBuilder"],"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":"contentId","type":"integer","required":true,"description":"ID of the content to get data for.","format":"integer","in":"path"},{"name":"frontendLang","type":"string","required":false,"description":"Language to be used when rendering frontend widgets.","format":"string","in":"query"}]},"options":{"summary":"Get cross origin headers.","description":"Get cross origin headers.","tags":["ShopBuilder"],"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":["ShopBuilder"],"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":"The ID of the content to duplicate.","format":"integer","in":"path"},{"name":"targetPluginSetId","type":"integer","required":false,"description":"ID of the plugin set to link the duplicate to.","format":"integer","in":"query"},{"name":"language","type":"string","required":false,"description":"Language to link the duplicate to.","format":"string","in":"query"},{"name":"containerName","type":"string","required":false,"description":"Layout container to link the duplicate to.","format":"string","in":"query"},{"name":"contentName","type":"string","required":false,"description":"Name of the duplicted content.","format":"string","in":"query"}]},"put":{"summary":"Update a content.","description":"Updates a ShopBuilder content. If not data are provided, content will be rebuilt.","tags":["ShopBuilder"],"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":"contentId","type":"integer","required":true,"description":"The ID of the content to update.","format":"integer","in":"path"},{"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\/{contentId}","schema":{"type":"object","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\/contents\/{contentId}\/versions":{"get":{"summary":"List content versions.","description":"List versions of a specified content.","tags":["ShopBuilder"],"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":"contentId","type":"integer","required":true,"description":"ID of the content to get versions for.","format":"integer","in":"path"},{"name":"itemsPerPage","type":"integer","required":false,"description":"The number of items to list per page.","format":"integer","in":"query"},{"name":"versionIdMarker","type":"string","required":false,"description":"ID of a version to get subsequent versions from.","format":"string","in":"query"}]}},"\/rest\/shop_builder\/contents\/{contentId}\/versions\/{versionId}":{"put":{"summary":"Restore content version.","description":"Restore a specific content version.","tags":["ShopBuilder"],"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":"contentId","type":"integer","required":true,"description":"The ID of the content to be restored to a previous version.","format":"integer","in":"path"},{"name":"versionId","type":"string","required":true,"description":"ID of the version to restore the content to.","format":"string","in":"path"}]}},"\/rest\/shop_builder\/data_fields":{"get":{"summary":"Resolve a data field provider class and return all registered entries and child providers.","description":"Resolve a data field provider class and return all registered entries and child providers.","tags":["ShopBuilder"],"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":"providerClass","type":"string","required":false,"description":"Class name of the data field provider to resolve.","format":"string","in":"query"}]},"options":{"summary":"Get cross origin headers.","description":"Get cross origin headers.","tags":["ShopBuilder"],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Response"}}}}},"\/rest\/shop_builder\/frontend":{"get":{"summary":"Get contents of all shopBuilder.json files from all frontend plugins.","description":"Get contents of all shopBuilder.json files from all frontend plugins.","tags":["ShopBuilder"],"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":"pluginSetId","type":"integer","required":false,"description":"Id of the plugin set to read frontend configurations for.","format":"integer","in":"query"}]}},"\/rest\/shop_builder\/global_settings":{"get":{"summary":"Get global settings defined by frontend plugins in shopBuilder.json files.","description":"Get global settings defined by frontend plugins in shopBuilder.json files.","tags":["ShopBuilder"],"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."}}},"put":{"summary":"Update global settings by calling registered settings handler for each frontend plugin.","description":"Update global settings by calling registered settings handler for each frontend plugin.","tags":["ShopBuilder"],"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\/shop_builder\/pages":{"get":{"summary":"List content pages","description":"List content pages from all plugins in a given plugin set.","tags":["ShopBuilder"],"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\/sass\/compile":{"get":{"summary":"Compile a single sass file.","description":"Compile a single sass file. Optionally prepend variables.","tags":["ShopBuilder"],"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":"path","type":"string","required":false,"description":"The path to the sass file to be compiled.","format":"string","in":"query"},{"name":"variables","type":"string","required":false,"description":"An optional sass formatted string to be prepended to the file content.","format":"string","in":"query"}]}},"\/rest\/shop_builder\/search":{"get":{"summary":"Search in multiple sources.","description":"Search in multiple sources.","tags":["ShopBuilder"],"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":"query","type":"string","required":false,"description":"The query to search for.","format":"string","in":"query"},{"name":"maxPerSource","type":"integer","required":false,"description":"Maximum number of results per search source.","format":"integer","in":"query"},{"name":"sources","type":"array","required":false,"description":"Sources to consider during search.","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/shop_builder\/search\/{source}\/{id}":{"get":{"summary":"Get a single entity from a specified source.","description":"Get a single entity from a specified source.","tags":["ShopBuilder"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/SearchResult"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"source","type":"string","required":true,"description":"The source to get the entry for.","format":"string","in":"path"},{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/shop_builder\/widgets":{"get":{"summary":"List all widgets","description":"List all widgets provided by all frontend plugins of a given plugin set.","tags":["ShopBuilder"],"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"},{"name":"contentType","type":"string","required":false,"description":"Filter results that are allowed for the given content type.","format":"string","in":"query"}]},"options":{"summary":"Get cross origin headers.","description":"Get cross origin headers.","tags":["ShopBuilder"],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Response"}}}},"post":{"summary":"Render the preview for widgets","description":"Render the preview for widgets","tags":["ShopBuilder"],"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"},{"name":"contentType","type":"string","required":false,"description":"Provide a content type to widgets should be rendered within.","format":"string","in":"query"}]}},"\/rest\/stock\/reservations":{"get":{"summary":"List stock reservations","description":"Lists stock reservations as a paginated result","tags":["Stock"],"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 Reservation","items":{"$ref":"#\/definitions\/Reservation"}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"warehouseId":18,"itemId":910,"variationId":1249,"stockPhysical":22,"reservedStock":3,"reservedEbay":0,"reorderDelta":-16,"stockNet":19,"reordered":0,"reservedBundle":0,"averagePurchasePrice":531.95,"updatedAt":"2025-09-02T14:33:25+02:00"},{"warehouseId":9,"itemId":306,"variationId":3106,"stockPhysical":29,"reservedStock":3,"reservedEbay":0,"reorderDelta":-23,"stockNet":26,"reordered":0,"reservedBundle":0,"averagePurchasePrice":534.37,"updatedAt":"2025-08-14T02:34:48+02:00"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The properties to be loaded.","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/stockmanagement\/stock\/archives":{"get":{"summary":"List archive years of stock movements","description":"Retrieves a list of years of archives for the stock movements.","tags":["StockManagement"],"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\/stockmanagement\/stock\/redistribute":{"put":{"summary":"Redistribute stock","description":"Redistributes stock of one storage location among one or more storage locations.\nNote: If variation has Batch or BBD, they need to be included in the redistribution object.","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","properties":{"redistributions":{"type":"array","items":{"$ref":"#\/definitions\/VariationStockRedistribution"}},"variationId":{"type":"integer","description":"The ID of the variation optional"},"reasonId":{"type":"integer","description":"The reason for the redistribution. Valid reasons are:\n\n 401: Stock transfer\n 402: Stock correction by stocktaking\n 403: 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 optional"},"currentWarehouseId":{"type":"integer","description":"The ID of the current warehouse"},"newStorageLocationId":{"type":"integer","description":"The ID of the new storage location optional"},"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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"warehouseId":3,"itemId":515,"variationId":3167,"stockPhysical":75,"reservedStock":6,"reservedEbay":0,"reorderDelta":-67,"stockNet":69,"reordered":0,"reservedBundle":0,"averagePurchasePrice":306.7,"updatedAt":"2025-08-13T13:18:13+02:00"},{"warehouseId":20,"itemId":872,"variationId":5000,"stockPhysical":60,"reservedStock":2,"reservedEbay":0,"reorderDelta":-56,"stockNet":58,"reordered":0,"reservedBundle":0,"averagePurchasePrice":592.47,"updatedAt":"2025-08-26T11:39:50+02:00"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The properties to be loaded.","format":"","in":"query","items":{"type":"string"}},{"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":"array","required":false,"description":"Related objects to be loaded. repairWarehouse is the only relation currently available.","format":"","in":"query","items":{"type":"string"}}]},"post":{"summary":"Create a warehouse","description":"Creates a warehouse.","tags":["StockManagement"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Warehouse"},"examples":{"application\/json":{"address":{"name1":null,"address1":null,"address2":null,"postalCode":null,"town":null,"countryId":null,"options":[{"typeId":5,"value":""},{"typeId":4,"value":""}],"title":"","contactPerson":"","taxIdNumber":""}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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 stocktaking 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"},"examples":{"application\/json":{"address":{"name1":null,"address1":null,"address2":null,"postalCode":null,"town":null,"countryId":null,"options":[{"typeId":5,"value":""},{"typeId":4,"value":""}],"title":"","contactPerson":"","taxIdNumber":""}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"Related objects to be loaded. 'repairWarehouse' is the only relation currently available.","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/addresses\/{relationTypeId}":{"get":{"summary":"List warehouse addresses","description":"List warehouse addresses. The ID of the warehouse, the address and the ID of the relation type must be specified.","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."}},"parameters":[{"name":"warehouseId","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"name":"relationTypeId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/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"},"examples":{"application\/json":{"name":"et","warehouseId":1,"rackId":3,"shelfId":6,"position":6,"type":"europallet"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The attributes to be loaded.","format":"","in":"query","items":{"type":"string"}},{"name":"with","type":"array","required":false,"description":"The relations to be loaded. Possible values are 'warehouse', 'rack' and 'shelf'.","format":"","in":"query","items":{"type":"string"}}]}},"\/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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"warehouseId":4,"itemId":447,"variationId":1982,"stockPhysical":93,"reservedStock":4,"reservedEbay":0,"reorderDelta":-84,"stockNet":89,"reordered":0,"reservedBundle":0,"averagePurchasePrice":237.59,"updatedAt":"2025-09-02T02:19:53+02:00"},{"warehouseId":6,"itemId":455,"variationId":1674,"stockPhysical":75,"reservedStock":9,"reservedEbay":0,"reorderDelta":-64,"stockNet":66,"reordered":0,"reservedBundle":0,"averagePurchasePrice":856.51,"updatedAt":"2025-08-17T21:19:08+02:00"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The properties to be loaded.","format":"","in":"query","items":{"type":"string"}},{"name":"reasonId","type":"integer","required":false,"description":"The ID of the reason","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","properties":{"incomingItems":{"type":"array","items":{"$ref":"#\/definitions\/VariationStockIntake"}},"variationId":{"type":"integer","description":"The ID of the variation optional"},"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 optional"},"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","properties":{"outgoingItems":{"type":"array","items":{"$ref":"#\/definitions\/VariationStockDischarge"}},"variationId":{"type":"integer","description":"The ID of the variation optional"},"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 optional"},"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","properties":{"corrections":{"type":"array","items":{"$ref":"#\/definitions\/VariationStockCorrection"}},"variationId":{"type":"integer","description":"The ID of the variation optional"},"quantity":{"type":"number","description":"The quantity of the variation"},"storageLocationId":{"type":"integer","description":"The ID of the storage location optional"},"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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"id":3185,"itemId":378,"variationId":9031,"warehouseId":2,"reasonString":"Warenausgang (WA)","attributeValues":"","processRowId":7048,"quantity":-2,"reason":201,"createdAt":"2025-09-05T07:11:14+02:00","processRowType":2,"storageLocationName":"Default storage location","warehouseName":"Sales warehouse #2","purchasePrice":76.28,"userId":17,"batch":6625,"bestBeforeDate":"1994-08-31"},{"id":4952,"itemId":433,"variationId":4620,"warehouseId":4,"reasonString":"Wareneingang (WE)","attributeValues":"","processRowId":1727,"quantity":3,"reason":101,"createdAt":"2025-08-19T03:10:51+02:00","processRowType":1,"storageLocationName":"Default storage location","warehouseName":"Sales warehouse #4","purchasePrice":34.92,"userId":11,"batch":3033,"bestBeforeDate":"1979-10-07"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"reasonGroup","type":"integer","required":false,"description":"The ID of the reason","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":"array","required":false,"description":"The properties to be loaded","format":"","in":"query","items":{"type":"string"}},{"name":"processRowType","type":"integer","required":false,"description":"The type of the process, 2=order","format":"integer","in":"query"},{"name":"orderId","type":"integer","required":false,"description":"The id of the order","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"itemId":877,"variationId":4764,"storageLocationId":13,"warehouseId":8,"quantity":62,"updatedAt":"2025-08-15T05:59:21+02:00","storageLocation":[],"batch":"","bestBeforeDate":""},{"itemId":392,"variationId":5932,"storageLocationId":12,"warehouseId":18,"quantity":2,"updatedAt":"2025-08-22T11:54:23+02:00","storageLocation":[],"batch":"","bestBeforeDate":""}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The properties to be loaded.","format":"","in":"query","items":{"type":"string"}},{"name":"with","type":"array","required":false,"description":"Load additional relations for a StockStorageLocation. Possible values:\n <ul>\n <li>'storageLocation' = The storageLocation this stock information belongs to.<\/li>\n <\/ul>\n Example: <code>?with[]=storageLocation<\/code>","format":"","in":"query","items":{"type":"string"}},{"name":"warehouseId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/stock\/storageLocationsPim":{"get":{"summary":"List stock of a warehouse per storage location with pim entry","description":"Lists stock of a warehouse for each variation and storage location with pim entry. 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"itemId":297,"variationId":8409,"storageLocationId":1,"warehouseId":7,"quantity":74,"updatedAt":"2025-08-15T11:23:25+02:00","storageLocation":[],"batch":"","bestBeforeDate":""},{"itemId":375,"variationId":2085,"storageLocationId":5,"warehouseId":1,"quantity":8,"updatedAt":"2025-08-22T08:55:27+02:00","storageLocation":[],"batch":"","bestBeforeDate":""}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The properties to be loaded.","format":"","in":"query","items":{"type":"string"}},{"name":"with","type":"array","required":false,"description":"Load additional relations for a StockStorageLocation. Possible values:\n <ul>\n <li>'storageLocation' = The storageLocation this stock information belongs to.<\/li>\n <\/ul>\n Example: <code>?with[]=warehouseLocation<\/code>","format":"","in":"query","items":{"type":"string"}},{"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"},"examples":{"application\/json":{"address":{"name1":null,"address1":null,"address2":null,"postalCode":null,"town":null,"countryId":null,"options":[{"typeId":5,"value":""},{"typeId":4,"value":""}],"title":"","contactPerson":"","taxIdNumber":""}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":true,"description":"The new item that will be booked in as result of the unpacking","format":"","in":"query","items":{"type":"string"}},{"name":"VariationStockCorrection","type":"array","required":true,"description":"The item that is unpacked","format":"","in":"query","items":{"type":"string"}},{"name":"warehouseId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/{warehouseLocationId}\/stock\/bookStocktaking":{"put":{"summary":"Book stocktaking","description":"Corrects stock of a storage location. Every variation that is currently present on the provided storageLocation and is not provided\nin the request will be set to quantity 0.","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"},{"name":"$warehouseLocationId","type":"integer","required":true,"description":"The ID of the warehouseLocation.","format":"integer","in":"query"},{"name":"warehouseLocationId","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"in":"body","name":"\/rest\/stockmanagement\/warehouses\/{warehouseId}\/{warehouseLocationId}\/stock\/bookStocktaking","schema":{"type":"object","properties":{"corrections":{"type":"array","items":{"$ref":"#\/definitions\/VariationStockCorrection"}},"variationId":{"type":"integer","description":"The ID of the variation optional"},"quantity":{"type":"number","description":"The quantity of the variation"},"storageLocationId":{"type":"integer","description":"The ID of the storage location optional"},"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\/storage\/frontend\/file":{"delete":{"summary":"Delete object from frontend storage","description":"Remove a single object from frontend storage.","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","description":"Get file information for a single object in frontend storage. Append public cloudfront url to retrieved object.","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"}]},"put":{"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":"sourceKey","type":"string","required":true,"description":"The key of the object to rename.","format":"string","in":"query"},{"name":"targetKey","type":"string","required":true,"description":"The new key to store the object at.","format":"string","in":"query"}]}},"\/rest\/storage\/frontend\/file\/metadata":{"get":{"summary":"Get metadata for storage object","description":"Get assigned metadata for a single storage object","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 storage object","description":"Update metadata of an storage object.","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":"array","required":true,"description":"The metadata to assign to storage object","format":"","in":"query","items":{"type":"string"}}]}},"\/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":"array","required":true,"description":"List of storage keys for the files to be deleted.","format":"","in":"query","items":{"type":"string"}}]},"get":{"summary":"List frontend storage files","description":"List files from frontend storage. Append public cloudfront url to each retrieved object.","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 <code>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 <code>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":"array","required":true,"description":"List of storage keys for the files to be deleted.","format":"","in":"query","items":{"type":"string"}}]},"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 <code>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 <code>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 <code>continuationToken<\/code> as well as the returned\ntoken from the previous call as the value.\n\nCheck the <code>isTruncated<\/code> field in the response to see if more results are available. If <code>isTruncated<\/code> is true,\nrepeat the request using the token from the <code>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 <code>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 * <code>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"},"examples":{"application\/json":{"contentType":"Bool","contentLength":4,"content":"true"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":true,"description":"List of storage keys for the files to be deleted.","format":"","in":"query","items":{"type":"string"}}]},"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 <code>key<\/code> field.","format":"string","in":"query"}]}},"\/rest\/storage\/plugins\/inbox\/commit":{"post":{"summary":"Commit plugin changes","description":"Commits all plugin changes.","tags":["Cloud"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/mixed"}},"examples":{"application\/json":{"successful":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 <code>prefix<\/code> key with the value <code>PluginA\/src\/<\/code> will only return files in the <b>src<\/b> folder of <b>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 <code>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"},"examples":{"application\/json":{"name":"Micronesia","clientId":2912945,"countryId":311,"plentyId":13528}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/subscriptions":{"post":{"summary":"Create a subscription","description":"Creates a subscription","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":7,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/subscriptions\/preview":{"post":{"summary":"Get a subscription create preview.","description":"Returns a subscription preview for the given order data without creating a subscription.","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\/subscriptions\/{orderId}":{"delete":{"summary":"Delete a subscription","description":"Deletes a subscription. 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 subscription","description":"Updates a subscription. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":5,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/subscriptions\/{orderId}\/currency":{"put":{"summary":"Update the currency","description":"Update the currency for a subscription","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":9,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/subscriptions\/{orderId}\/manual_run":{"post":{"summary":"Create an order for today for a given subscription.","description":"Creates an order for today for a given subscription.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":9,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/subscriptions\/{orderId}\/preview":{"put":{"summary":"Get a subscription update preview","description":"Returns a subscription preview for the given order data without updating a subscription. The order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/system\/cloud\/metrics":{"get":{"summary":"Get cloud metrics","description":"Get the cloud metrics for this system","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":"Get System metrics","description":"Supply usage data for given plentymarkets system","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":"Lists the specified taric vat assignments in the request. This checks the results for the page and items per page\nspecified in the request.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"taricCode":"2381258842","countryId":1,"vatField":2},{"taricCode":"9337404256","countryId":6,"vatField":2}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","properties":{"taricCode":{"type":"integer","description":"The taric code matching to \/^[0-9a-zA-Z\\\/-]{1,30}$\/"},"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"},"examples":{"application\/json":{"taricCode":"8124598339","countryId":8,"vatField":5}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"taricCode":"3512697453","countryId":7,"vatField":3}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","properties":{"taricCode":{"type":"integer","description":"The taric code matching to \/^[0-9a-zA-Z\\\/-]{1,30}$\/"},"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."}}}}]},"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"},"examples":{"application\/json":{"taricCode":"8213681205","countryId":2,"vatField":2}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","properties":{"taricCode":{"type":"integer","description":"The taric code matching to \/^[0-9a-zA-Z\\\/-]{1,30}$\/"},"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."}}}}]}},"\/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: <ul><li>availabilities = The tag availabilities<\/li><li>names = The tag names<\/li><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":"Creates a tag. The fields tagName and names must be specified.","tags":["Tag"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Tag"},"examples":{"application\/json":{"tagName":"Lloyd Cremin","color":"#43e459"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"tagName","type":"string","required":true,"description":"The name of the tag","format":"string","in":"query"},{"name":"tagLang","type":"string","required":true,"description":"tagLang is used in names. The names field contains multiple languages.","format":"string","in":"query"},{"in":"body","name":"\/rest\/tags","schema":{"type":"object","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, reorder, redistribution, subscription, messenger, messageBillable, messageClearingSubAccount, document, documentTemplate, plentyFunction"},"clients":{"type":"array","items":{"$ref":"#\/definitions\/TagClient"}},"plentyId":{"type":"integer","description":"The PlentyId of the client"},"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, fi, ga, lt, lv, et, hr, hu"}}}}]}},"\/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","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, reorder, redistribution, subscription, messenger, messageBillable, messageClearingSubAccount, document, documentTemplate, plentyFunction"},"clients":{"type":"array","items":{"$ref":"#\/definitions\/TagClient"}},"plentyId":{"type":"integer","description":"The PlentyId of the client"},"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, fi, ga, lt, lv, et, hr, hu"}}}}]},"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","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, reorder, redistribution, subscription, messenger, messageBillable, messageClearingSubAccount, document, documentTemplate, plentyFunction"},"clients":{"type":"array","items":{"$ref":"#\/definitions\/TagClient"}},"plentyId":{"type":"integer","description":"The PlentyId of the client"},"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, fi, ga, lt, lv, et, hr, hu"}}}}]}},"\/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: <ul><li>availability = The tag availability<\/li><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"},"examples":{"application\/json":{"tagId":1071,"tagType":"item","relationshipValue":9691}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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, messageClearingSubAccount, document, documentTemplate, plentyFunction"},"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. <b>category<\/b>, <b>item<\/b> or <b>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"}]}},"\/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"},"examples":{"application\/json":{"tagName":"Ollie Bartell MD","color":"#749fb6"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"tagName":"Colin Torphy","color":"#eabce9"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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, reorder, redistribution, subscription, messenger, messageBillable, messageClearingSubAccount, document, documentTemplate, plentyFunction"},"clients":{"type":"array","items":{"$ref":"#\/definitions\/TagClient"}},"plentyId":{"type":"integer","description":"The PlentyId of the client"},"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, fi, ga, lt, lv, et, hr, hu"}}}}]}},"\/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. <b>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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"typeId":2,"priorityId":5,"parentTicketId":null,"statusId":6,"confidential":0,"contactId":null,"title":"Commodi nulla adipisci ducimus fugit et ut. Quia excepturi quis et ratione fuga doloremque. Doloremque alias illum fugit fugiat qui sit. Rerum optio ut atque modi. Occaecati quam illo exercitationem eum cumque vel rem. Aut culpa est quis.","progress":87,"plentyId":0,"source":"backend","documentsCount":0,"hasDocuments":0,"childrenCount":0,"resubmissionAt":"1977-05-31T00:00:00+01:00","deadlineAt":"2024-05-10T00:00:00+02:00"},{"typeId":1,"priorityId":6,"parentTicketId":null,"statusId":2,"confidential":1,"contactId":null,"title":"Optio distinctio laudantium ad quisquam assumenda adipisci. Iusto aspernatur officia qui voluptatem nulla fuga architecto. Quis et ipsum est enim perspiciatis. Ducimus voluptatibus explicabo commodi.","progress":61,"plentyId":0,"source":"backend","documentsCount":0,"hasDocuments":0,"childrenCount":0,"resubmissionAt":"1997-11-24T00:00:00+01:00","deadlineAt":"2022-10-25T00:00:00+02:00"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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. The fields typeId, statusId, title, plentyId, source and owners must be specified.","tags":["Ticket"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Ticket"},"examples":{"application\/json":{"typeId":1,"priorityId":6,"parentTicketId":null,"statusId":4,"confidential":0,"contactId":null,"title":"Placeat dolorem maxime quae eum velit nesciunt. Maiores eveniet qui autem. Sed non at sequi sint.","progress":28,"plentyId":0,"source":"backend","documentsCount":0,"hasDocuments":0,"childrenCount":0,"resubmissionAt":"2006-02-21T00:00:00+01:00","deadlineAt":"1986-08-15T00:00:00+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"string","required":true,"description":"The ID from the status of the ticket","format":"string","in":"query"},{"name":"statusId","type":"string","required":true,"description":"The ID from the status of the ticket","format":"string","in":"query"},{"name":"title","type":"string","required":true,"description":"The name of the ticket","format":"string","in":"query"},{"name":"plentyId","type":"string","required":true,"description":"The plentyId","format":"string","in":"query"},{"name":"source","type":"string","required":true,"description":"The source of the ticket","format":"string","in":"query"},{"name":"userId","type":"string","required":true,"description":"userId is used in owners. The owners field contains multiple owners.","format":"string","in":"query"},{"name":"roleId","type":"string","required":true,"description":"roleId is used in owners and refers to the ticket role. The owners field contains multiple owners.","format":"string","in":"query"},{"in":"body","name":"\/rest\/tickets","schema":{"type":"object","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"},"examples":{"application\/json":{"type":"comment","text":"Consectetur adipisci repellendus nihil modi soluta voluptas. Fugiat nihil doloremque qui. Enim aut dolorem ad doloremque tenetur. Ut aut sunt inventore reprehenderit.","userId":1,"source":null,"topicId":4}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 all status names of the ticket types.","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"},"examples":{"application\/json":{"typeId":2,"priorityId":6,"parentTicketId":null,"statusId":5,"confidential":0,"contactId":null,"title":"Totam quia adipisci maiores. Voluptatem impedit hic et laudantium voluptate molestiae. Omnis sed aut eum nobis. Et saepe deleniti hic.","progress":50,"plentyId":0,"source":"backend","documentsCount":0,"hasDocuments":0,"childrenCount":0,"resubmissionAt":"2007-03-09T00:00:00+01:00","deadlineAt":"1975-11-05T00:00:00+01:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"An array with relations to be loaded with the ticket. Possible values are 'order' and 'contact'","format":"","in":"query","items":{"type":"string"}}]},"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"},"examples":{"application\/json":{"type":"comment","text":"Ut incidunt explicabo vel labore dolore accusamus vero. Et consequatur est maxime est. Rerum qui aut quis illo ea hic accusamus laboriosam. Tempore molestiae quod tenetur quia.","userId":1,"source":null,"topicId":5}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"typeId":2,"priorityId":4,"parentTicketId":null,"statusId":4,"confidential":1,"contactId":null,"title":"Et ipsam aut et. Veritatis voluptatem consequatur mollitia incidunt necessitatibus dolorum rerum. Unde reiciendis vel fugiat id in. Eius natus voluptas modi esse.","progress":89,"plentyId":0,"source":"backend","documentsCount":0,"hasDocuments":0,"childrenCount":0,"resubmissionAt":"1971-02-10T00:00:00+01:00","deadlineAt":"1984-03-31T00:00:00+02:00"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"type":"message","text":"At consectetur molestiae delectus et dolores a ut. Laborum eveniet pariatur et qui consequatur soluta ea. Commodi qui ex deserunt voluptate eaque quasi. Et ipsam sapiente cupiditate consequuntur.","userId":2,"source":"backend","topicId":null},{"type":"comment","text":"Cumque quia sit accusantium odit molestias iste. Dolore dolorum qui ducimus nihil vel est doloribus similique.","userId":null,"source":null,"topicId":3}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"type":"message","text":"Ea ducimus praesentium quia odio esse. Cum aut ut iste alias. Aspernatur fugiat laudantium repellendus. Qui dolorum est et saepe laudantium omnis.","userId":3,"source":"ebay","topicId":null},{"type":"message","text":"Vero explicabo saepe mollitia aliquid molestiae illo quisquam iusto. Praesentium autem dolorum possimus occaecati inventore nihil tempora. Consectetur id ullam necessitatibus.","userId":null,"source":null,"topicId":3}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}},"examples":{"application\/json":[{"type":"comment","text":"Labore voluptatem ratione dolor eius. Quos odio non recusandae. Ea sunt maxime impedit sed voluptas velit. Porro iste dolorem at totam.","userId":null,"source":"ebay","topicId":null},{"type":"message","text":"Commodi vero sed officia voluptate animi eius. Natus quia sed dolores pariatur. Voluptates dolor accusantium similique fuga.","userId":5,"source":null,"topicId":3}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/todo":{"delete":{"summary":"Delete a list of todos","description":"Deletes a list of todos.","tags":["Todo"],"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 for todos","description":"Searches todos. Returns a paginated result.","tags":["Todo"],"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 Todo","items":{"$ref":"#\/definitions\/Todo"}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]},"post":{"summary":"Create a list of todos","description":"Creates a list of new todo.","tags":["Todo"],"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 a list of tasks","description":"Updates a list of tasks.","tags":["Todo"],"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\/todo\/{id}":{"get":{"summary":"","description":"","tags":[""],"responses":{"200":{"description":"OK"}}}},"\/rest\/user":{"get":{"summary":"Get 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"},"examples":{"application\/json":{"id":3,"user":"vthiel_88847","realName":"Jaquan Corkery MD","lang":"oc","ipLimit":"","ustatus":2,"memberId":0,"timestamp":{"date":"2025-04-02 13:39:57.000000","timezone_type":3,"timezone":"Europe\/Berlin"},"email":"ltorphy@koss.info","timezone":"Europe\/Berlin","googleEmail":"","skype":"","ical":"","psConfig":0,"psItem":0,"psEbay":0,"psStock":0,"psCustomer":0,"psOrder":0,"psStats":0,"psData":0,"pcConfig":0,"pcContent":0,"pcNewsletter":0,"pcLayout":0,"pcDialog":0,"pcStats":0,"pcData":0,"pcBlog":0,"signature":null,"color":"#000000","eks":1,"payments":1,"acceptAgb":0,"api":0,"image":"","delOrder":0,"delArticle":0,"delRecord":0,"plentystat":0,"plentyconnect":0,"webspaceAccess":0,"accessControlList":"","plentymarketsShippingOrderId":0,"plentymarketsShippingItem":0,"plentymarketsShippingAuto":0,"plentymarketsShippingLabel":0,"plentymarketsShippingConfig":0,"warehouseId":null,"calendar":0,"orderStatus":"","warehouseRepairId":null,"project":0,"ticket":0,"order":0,"blog":0,"lead":0,"customer":0,"totalVacationDays":"0","roleId":null,"salutation":"","dataLang":"de","disabled":0,"scheduler":0,"item":0,"incomingItems":0,"backendPluginSetId":null,"global_roles":"[]"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\nthe 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 backend plugin set","description":"Get the backend plugin set for user","tags":["User"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PluginSet"},"examples":{"application\/json":{"name":"nemo","hash":"MTV7Yjc"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 backend plugin set","description":"Set the backend plugin set for user","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 users with pin","description":"Get all users with a secret value\/pin.","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.\nThis 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\/users\/{id}\/reset_failed_attempts":{"post":{"summary":"Reset failed authentication attempts","description":"Reset the failed authentication attempts of a user using the UserID","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."}},"parameters":[{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/v2\/catalogs\/channel-maps":{"get":{"summary":"Get a list of Channel Maps","description":"Gets a list of Channel Maps","tags":["Catalog"],"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":"Create a Channel Map","description":"Creates a Channel Map","tags":["Catalog"],"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\/v2\/catalogs\/channel-maps\/generate\/{channelMapId}\/{statusId}":{"post":{"summary":"Generate a channel map","description":"Generates a channel map","tags":["Catalog"],"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."}},"parameters":[{"name":"channelMapId","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"name":"statusId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/v2\/catalogs\/channel-maps\/generator\/benchmark":{"get":{"summary":"Benchmark for generation of a channel map template","description":"Benchmark for generation of a channel map template","tags":["Catalog"],"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\/v2\/catalogs\/channel-maps\/regenerate\/{channelMapId}":{"post":{"summary":"Regenerate a channel map","description":"Regenerates a channel map . Channel map id must be provided","tags":["Catalog"],"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."}},"parameters":[{"name":"channelMapId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/v2\/catalogs\/channel-maps\/templates\/type\/{type}":{"get":{"summary":"Get templates for type","description":"Gets a templates for a type","tags":["Catalog"],"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."}},"parameters":[{"name":"type","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/v2\/catalogs\/channel-maps\/templates\/type\/{type}\/subtype\/{subtype}":{"get":{"summary":"Get templates by type and subtype","description":"Gets all templates by type and subtype","tags":["Catalog"],"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."}},"parameters":[{"name":"type","type":"integer","required":true,"description":"","format":"integer","in":"path"},{"name":"subtype","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/v2\/catalogs\/channel-maps\/templates\/types":{"get":{"summary":"Get types","description":"Gets all types","tags":["Catalog"],"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\/v2\/catalogs\/channel-maps\/{id}":{"delete":{"summary":"Delete a Channel Map","description":"Deletes a Channel Map","tags":["Catalog"],"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 Channel Map","description":"Gets a specific Channel Map based on its ID.","tags":["Catalog"],"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."}},"parameters":[{"name":"id","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"put":{"summary":"Update a Channel Map","description":"Updates a Channel Map","tags":["Catalog"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/ChannelMap"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/v2\/properties":{"get":{"summary":"Search for properties","description":"Searches for properties. Filters can be specified. Sort by argument can be specified. Sort order can be specified.","tags":["Property"],"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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"cast":"empty","type":"stock","position":9},{"cast":"multiSelection","type":"stock","position":3}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'names' = The names of the property.<\/li><li>'amazon' = The amazon values of the property.<\/li><li>'options' = The options of the property.<\/li><li>'groups' = The groups of the property.<\/li><\/ul>","format":"string","in":"query"},{"name":"orderBy","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.","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"},{"name":"id","type":"integer","required":false,"description":"Filter restricts the list of results to properties which have have a matching ID. Possible search operators are: 'eq', 'in', 'gte', 'gt', 'lte', 'lt', 'between'","format":"integer","in":"query"},{"name":"cast","type":"string","required":false,"description":"Filter restricts the list of results to properties which have have a matching cast. Possible search operators are: 'eq', 'in'","format":"string","in":"query"},{"name":"group","type":"integer","required":false,"description":"Filter restricts the list of results to properties which have have a matching group id. Possible search operators are: 'eq', 'in'","format":"integer","in":"query"},{"name":"name","type":"string","required":false,"description":"Filter restricts the list of results to properties which have have a matching name. Possible search operators are: 'eq', 'like'","format":"string","in":"query"},{"name":"type","type":"string","required":false,"description":"Filter restricts the list of results to properties which have have a matching type. Possible search operators are: 'eq', 'in'","format":"string","in":"query"},{"name":"updatedAt","type":"string","required":false,"description":"Filter restricts the list of results to properties which have a matching updatedAt. Possible search operators are: 'between', 'gte', 'lte', 'gt', 'lt'.","format":"string","in":"query"},{"name":"option.units","type":"string","required":false,"description":"Filter restricts the list of results to properties which have a matching option with the type units. Possible search operators are: 'eq', 'in'.","format":"string","in":"query"},{"name":"option.vatId","type":"string","required":false,"description":"Filter restricts the list of results to properties which have a matching option with the type vatId. Possible search operators are: 'eq', 'in'.","format":"string","in":"query"},{"name":"option.displayOrder","type":"string","required":false,"description":"Filter restricts the list of results to properties which have a matching option with the type displayOrder. Possible search operators are: 'eq', 'in'.","format":"string","in":"query"},{"name":"option.markup","type":"string","required":false,"description":"Filter restricts the list of results to properties which have a matching option with the type markup. Possible search operators are: 'eq', 'in'.","format":"string","in":"query"},{"name":"option.mandatoryField","type":"string","required":false,"description":"Filter restricts the list of results to properties which have a matching option with the type mandatoryField. Possible search operators are: 'eq', 'in'.","format":"string","in":"query"},{"name":"option.orderProcess","type":"string","required":false,"description":"Filter restricts the list of results to properties which have a matching option with the type orderProcess. Possible search operators are: 'eq', 'in'.","format":"string","in":"query"},{"name":"option.customerRegistration","type":"string","required":false,"description":"Filter restricts the list of results to properties which have a matching option with the type customerRegistration. Possible search operators are: 'eq', 'in'.","format":"string","in":"query"},{"name":"option.contactSearch","type":"string","required":false,"description":"Filter restricts the list of results to properties which have a matching option with the type contactSearch. Possible search operators are: 'eq', 'in'.","format":"string","in":"query"},{"name":"visibility.referrers","type":"string","required":false,"description":"Filter restricts the list of results to properties which have a matching visibility with the type referrers. Possible search operators are: 'eq', 'in'.","format":"string","in":"query"},{"name":"visibility.clients","type":"string","required":false,"description":"Filter restricts the list of results to properties which have a matching visibility with the type clients. Possible search operators are: 'eq', 'in'.","format":"string","in":"query"},{"name":"visibility.display","type":"string","required":false,"description":"Filter restricts the list of results to properties which have a matching visibility with the type display. Possible search operators are: 'eq', 'in'.","format":"string","in":"query"},{"name":"visibility.opportunityStatus","type":"string","required":false,"description":"Filter restricts the list of results to properties which have a matching visibility with the type opportunityStatus. Possible search operators are: 'eq', 'in'.","format":"string","in":"query"}]},"post":{"summary":"Create a property","description":"Creates a property. At least one property name must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Property"},"examples":{"application\/json":{"cast":"selection","type":"stock","position":5}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties","schema":{"type":"object","properties":{"cast":{"type":"string","description":"The cast of the property (array values: 'empty','int','float','string','selection','text','html','date','file') allowed values are int, float, empty, string, text, html, selection, multiSelection, file, date"},"type":{"type":"string","description":"The type of the property (e.g. 'item' or 'contact') allowed values are item, stock, contact, opportunity"},"position":{"type":"integer","description":"The position of the property"},"names":{"type":"array","items":{}},"groups":{"type":"array","items":{}},"options":{"type":"array","items":{}},"amazon":{"type":"array","items":{"$ref":"#\/definitions\/PropertyAmazon"}},"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"},"selections":{"type":"array","items":{}}}}}]}},"\/rest\/v2\/properties\/amazon":{"post":{"summary":"Create a property amazon","description":"Creates a property amazon.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyAmazon"},"examples":{"application\/json":{"propertyId":1,"platform":"nl","category":"numquam","field":"animi"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties\/amazon","schema":{"type":"object","properties":{"propertyId":{"type":"integer","description":"The property ID of the property amazon"},"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"}}}}]}},"\/rest\/v2\/properties\/amazon\/{amazonId}":{"delete":{"summary":"Delete a property amazon","description":"Deletes a property amazon. The ID of the property amazon must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"amazonId","type":"integer","required":true,"description":"The ID of the property amazon","format":"integer","in":"path"}]},"get":{"summary":"Get a property amazon","description":"Gets a property amazon. The ID of the property amazon must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyAmazon"},"examples":{"application\/json":{"propertyId":1,"platform":"cz","category":"et","field":"dolor"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"amazonId","type":"integer","required":true,"description":"The ID of the property amazon","format":"integer","in":"path"}]},"put":{"summary":"Update a property amazon","description":"Updates a property amazon. The ID of the property amazon must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyAmazon"},"examples":{"application\/json":{"propertyId":1,"platform":"tr","category":"inventore","field":"id"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"amazonId","type":"integer","required":true,"description":"The ID of the property amazon","format":"integer","in":"path"},{"in":"body","name":"\/rest\/v2\/properties\/amazon\/{amazonId}","schema":{"type":"object","properties":{"propertyId":{"type":"integer","description":"The property ID of the property amazon"},"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"}}}}]}},"\/rest\/v2\/properties\/groups":{"get":{"summary":"Search for property groups","description":"Searches for property groups.","tags":["Property"],"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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"position":5},{"position":2}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'names' = The names of the property group.<\/li><li>'options' = The options of the property group.<\/li><\/ul>","format":"string","in":"query"},{"name":"orderBy","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.","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"}]},"post":{"summary":"Create a property group","description":"Creates a property group. At least one group name must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyGroup"},"examples":{"application\/json":{"position":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties\/groups","schema":{"type":"object","properties":{"position":{"type":"integer","description":"The position of the property group"},"names":{"type":"array","items":{}},"options":{"type":"array","items":{}}}}}]}},"\/rest\/v2\/properties\/groups\/names":{"post":{"summary":"Create a group name","description":"Creates a group name.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyGroupName"},"examples":{"application\/json":{"groupId":21,"lang":"da","name":"Moshe Wolf Jr."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties\/groups\/names","schema":{"type":"object","properties":{"groupId":{"type":"integer","description":"The property group 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 allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"name":{"type":"string","description":"The name of the property group optional"}}}}]}},"\/rest\/v2\/properties\/groups\/names\/{nameId}":{"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","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 group name","format":"integer","in":"path"}]},"get":{"summary":"Get a group name","description":"Gets a group name. The ID of the group must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyGroupName"},"examples":{"application\/json":{"groupId":20,"lang":"bg","name":"Llewellyn O'Conner"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 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"},"examples":{"application\/json":{"groupId":22,"lang":"tr","name":"Crystel Stroman"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 group name","format":"integer","in":"path"},{"in":"body","name":"\/rest\/v2\/properties\/groups\/names\/{nameId}","schema":{"type":"object","properties":{"groupId":{"type":"integer","description":"The property group 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 allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"name":{"type":"string","description":"The name of the property group optional"}}}}]}},"\/rest\/v2\/properties\/groups\/options":{"post":{"summary":"Create a group option","description":"Creates a group option.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyGroupOption"},"examples":{"application\/json":{"groupId":26,"type":"groupType","value":"voluptate"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties\/groups\/options","schema":{"type":"object","properties":{"groupId":{"type":"integer","description":"The property group ID of the property group"},"type":{"type":"string","description":"The identifier of the property group option allowed values are surchargeType, groupType"},"value":{"type":"string","description":"The value of the property group option"}}}}]}},"\/rest\/v2\/properties\/groups\/options\/{optionId}":{"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","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionId","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 must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyGroupOption"},"examples":{"application\/json":{"groupId":25,"type":"surchargeType","value":"ullam"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionId","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"},"examples":{"application\/json":{"groupId":27,"type":"surchargeType","value":"natus"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionId","type":"integer","required":true,"description":"The ID of the group option","format":"integer","in":"path"},{"in":"body","name":"\/rest\/v2\/properties\/groups\/options\/{optionId}","schema":{"type":"object","properties":{"groupId":{"type":"integer","description":"The property group ID of the property group"},"type":{"type":"string","description":"The identifier of the property group option allowed values are surchargeType, groupType"},"value":{"type":"string","description":"The value of the property group option"}}}}]}},"\/rest\/v2\/properties\/groups\/relations":{"delete":{"summary":"Delete a group relation","description":"Deletes a group relation. The ID of the group relation must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 group relation","format":"integer","in":"query"}]},"get":{"summary":"Search for group relations","description":"Searches for group relations. Filter can be specified.","tags":["Property"],"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 PropertyGroupRelation","items":{"$ref":"#\/definitions\/PropertyGroupRelation"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"groupId":30,"propertyId":663},{"groupId":31,"propertyId":664}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'group' = The related property group.<\/li><li>'property' = The related property.<\/li><\/ul>","format":"string","in":"query"},{"name":"orderBy","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.","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"}]},"post":{"summary":"Create a group relation","description":"Creates a group relation.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyGroupRelation"},"examples":{"application\/json":{"groupId":32,"propertyId":665}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties\/groups\/relations","schema":{"type":"object","properties":{"propertyId":{"type":"integer","description":"The ID of the property"},"groupId":{"type":"integer","description":"The ID of the property group"}}}}]},"put":{"summary":"Create a group relation","description":"Creates a group relation.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PropertyGroupRelation"}},"examples":{"application\/json":[{"groupId":33,"propertyId":666},{"groupId":34,"propertyId":667}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties\/groups\/relations","schema":{"type":"object","properties":{"propertyId":{"type":"integer","description":"The ID of the property"},"groupId":{"type":"integer","description":"The ID of the property group"}}}}]}},"\/rest\/v2\/properties\/groups\/relations\/{relationId}":{"delete":{"summary":"Delete a group relation","description":"Deletes a group relation. The ID of the group relation must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 group relation","format":"integer","in":"path"}]},"get":{"summary":"Get a group relation","description":"Gets a group relation. The ID of the group must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyGroupRelation"},"examples":{"application\/json":{"groupId":35,"propertyId":668}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'group' = The related property group.<\/li><li>'property' = The related property.<\/li><\/ul>","format":"string","in":"query"},{"name":"relationId","type":"integer","required":true,"description":"The ID of the group relation","format":"integer","in":"path"}]}},"\/rest\/v2\/properties\/groups\/{groupId}":{"delete":{"summary":"Delete a property group","description":"Deletes a property group. The ID of the group must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 property","format":"integer","in":"path"}]},"get":{"summary":"Get a property group","description":"Gets a property group. The ID of the group must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyGroup"},"examples":{"application\/json":{"position":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"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:<ul><li>'names' = The names of the property group.<\/li><li>'options' = The options of the property group.<\/li><\/ul>","format":"string","in":"query"}]},"put":{"summary":"Update a property group","description":"Updates a property group. The ID of the group must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyGroup"},"examples":{"application\/json":{"position":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},{"in":"body","name":"\/rest\/v2\/properties\/groups\/{groupId}","schema":{"type":"object","properties":{"position":{"type":"integer","description":"The position of the property group"},"names":{"type":"array","items":{}},"options":{"type":"array","items":{}}}}}]}},"\/rest\/v2\/properties\/groups\/{groupId}\/names":{"get":{"summary":"Get group names by group ID","description":"Gets group names for the specified group ID.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PropertyGroupName"}},"examples":{"application\/json":[{"groupId":23,"lang":"hu","name":"Mr. Jules Toy V"},{"groupId":24,"lang":"it","name":"Amaya Collier II"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"","format":"integer","in":"path"}]}},"\/rest\/v2\/properties\/groups\/{groupId}\/options":{"get":{"summary":"Get group options by group ID","description":"Gets group options for the specified group ID.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PropertyGroupOption"}},"examples":{"application\/json":[{"groupId":28,"type":"surchargeType","value":"dignissimos"},{"groupId":29,"type":"groupType","value":"rerum"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"","format":"integer","in":"path"}]}},"\/rest\/v2\/properties\/names":{"post":{"summary":"Create a property name","description":"Creates a property name.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyName"},"examples":{"application\/json":{"propertyId":649,"lang":"ro","name":"Ms. Adaline Goyette"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties\/names","schema":{"type":"object","properties":{"propertyId":{"type":"integer","description":"The property ID of the property name"},"lang":{"type":"string","description":"The language of the property name as ISO 639-1 language code, e.g. en for English allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"name":{"type":"string","description":"The name of the property name optional"},"description":{"type":"string","description":"The description of the property name optional"}}}}]}},"\/rest\/v2\/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","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 property name. The ID of the property must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyName"},"examples":{"application\/json":{"propertyId":648,"lang":"pl","name":"Anne Stoltenberg"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"propertyId":650,"lang":"ga","name":"Mrs. Twila Kautzer"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},{"in":"body","name":"\/rest\/v2\/properties\/names\/{nameId}","schema":{"type":"object","properties":{"propertyId":{"type":"integer","description":"The property ID of the property name"},"lang":{"type":"string","description":"The language of the property name as ISO 639-1 language code, e.g. en for English allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"name":{"type":"string","description":"The name of the property name optional"},"description":{"type":"string","description":"The description of the property name optional"}}}}]}},"\/rest\/v2\/properties\/options":{"post":{"summary":"Create a property option","description":"Creates a property option","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyOption"},"examples":{"application\/json":{"propertyId":654,"type":"units","value":"Dr. Beulah Kling"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties\/options","schema":{"type":"object","properties":{"propertyId":{"type":"integer","description":"The property ID of the property option"},"type":{"type":"string","description":"The identifier type of the option"}}}}]}},"\/rest\/v2\/properties\/options\/{optionId}":{"delete":{"summary":"Delete a property option","description":"Deletes a property option. The ID of the property option must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionId","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"},"examples":{"application\/json":{"propertyId":653,"type":"units","value":"Mr. Stefan Runolfsdottir"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionId","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"},"examples":{"application\/json":{"propertyId":655,"type":"vatId","value":"Emmitt Schinner"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"optionId","type":"integer","required":true,"description":"The ID of the property option","format":"integer","in":"path"},{"in":"body","name":"\/rest\/v2\/properties\/options\/{optionId}","schema":{"type":"object","properties":{"propertyId":{"type":"integer","description":"The property ID of the property option"},"type":{"type":"string","description":"The identifier type of the option"}}}}]}},"\/rest\/v2\/properties\/relations":{"get":{"summary":"Search for property relations","description":"Searches for properties relations. Filters can be specified.","tags":["Property"],"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 PropertyRelation","items":{"$ref":"#\/definitions\/PropertyRelation"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"propertyId":669,"groupId":1,"type":"item","targetId":99155,"markup":729.11,"value":"1998-02-22"},{"propertyId":670,"groupId":1,"type":"stock","targetId":4,"markup":418684.48,"value":null}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'property' = The property of the property relation.<\/li><li>'group' = The property group of the property relation.<\/li><li>'values' = The values of the property relation.<\/li><li>'selectionValues' = The selection values of the property relation.<\/li><\/ul>","format":"string","in":"query"},{"name":"orderBy","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.","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"},{"name":"id","type":"integer","required":false,"description":"Filter restricts the list of results to property relations which have have a matching ID. Possible search operators are: 'eq', 'in', 'gte', 'gt', 'lte', 'lt', 'between'","format":"integer","in":"query"},{"name":"propertyId","type":"string","required":false,"description":"Filter restricts the list of results to property relations which have have a matching propertyId. Possible search operators are: 'eq', 'in', 'gte', 'gt', 'lte', 'lt', 'between'","format":"string","in":"query"},{"name":"targetId","type":"integer","required":false,"description":"Filter restricts the list of results to property relations which have have a matching target id. Possible search operators are: 'eq', 'in', 'gte', 'gt', 'lte', 'lt', 'between'","format":"integer","in":"query"},{"name":"property.cast","type":"string","required":false,"description":"Filter restricts the list of results to property relations which have have a matching proeprty cast. Possible search operators are: 'eq', 'in'","format":"string","in":"query"},{"name":"type","type":"string","required":false,"description":"Filter restricts the list of results to property relations which have have a matching type. Possible search operators are: 'eq', 'in'","format":"string","in":"query"},{"name":"updatedAt","type":"string","required":false,"description":"Filter restricts the list of results to property relations which have a matching updatedAt. Possible search operators are: 'between', 'gte', 'lte', 'gt', 'lt'.","format":"string","in":"query"}]},"post":{"summary":"Create a list of property relations","description":"Creates a list of property relations.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyRelation"},"examples":{"application\/json":{"propertyId":671,"groupId":1,"type":"stock","targetId":9,"markup":38143920.52,"value":"5355"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties\/relations","schema":{"type":"object","properties":{"propertyId":{"type":"integer","description":"The property ID of the property relation"},"type":{"type":"string","description":"The type of the property relation allowed values are item, stock, contact, opportunity"},"targetId":{"type":"integer","description":"The ID of the target of the property relation"},"groupId":{"type":"integer","description":"The property group ID of the property relation"},"markup":{"type":"number","description":"The mark up of the property relation optional"},"value":{"type":"string","description":"The value of the property relation optional"},"selectionValues":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelationSelection"}},"selectionId":{"type":"integer","description":"The selection ID of the property relation selection value"},"values":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelationValue"}},"lang":{"type":"string","description":"The language of the property relation value allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"description":{"type":"string","description":"The description of the property relation value optional"}}}}]},"put":{"summary":"Update a list of property relations","description":"Updates a list of property relations. The ID of the each relation must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelation"}},"examples":{"application\/json":[{"propertyId":673,"groupId":1,"type":"stock","targetId":2,"markup":455.21,"value":"87042207"},{"propertyId":674,"groupId":1,"type":"item","targetId":99156,"markup":24141.95,"value":null}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties\/relations","schema":{"type":"object","properties":{"groupId":{"type":"integer","description":"The property group ID of the property relation"},"markup":{"type":"number","description":"The mark up of the property relation optional"},"value":{"type":"string","description":"The value of the property relation optional"},"selectionValues":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelationSelection"}},"selectionId":{"type":"integer","description":"The selection ID of the property relation selection value"},"values":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelationValue"}},"lang":{"type":"string","description":"The language of the property relation value allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"description":{"type":"string","description":"The description of the property relation value optional"}}}}]}},"\/rest\/v2\/properties\/relations\/selections":{"post":{"summary":"Create a property relation selection","description":"Creates a property relation selection.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyRelationSelection"},"examples":{"application\/json":{"relationId":120,"selectionId":14}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties\/relations\/selections","schema":{"type":"object","properties":{"relationId":{"type":"integer","description":"The relation ID of the property relation selection value"},"selectionId":{"type":"integer","description":"The selection ID of the property relation selection value"}}}}]}},"\/rest\/v2\/properties\/relations\/selections\/{relationSelectionId}":{"delete":{"summary":"Delete a property relation selection","description":"Deletes a property relation selection. The ID of the relation selection must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"relationSelectionId","type":"integer","required":true,"description":"The ID of the relation selection","format":"integer","in":"path"}]},"get":{"summary":"Get a property relation selection","description":"Gets a property relation selection. The ID of the relation selection must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyRelationSelection"},"examples":{"application\/json":{"relationId":119,"selectionId":13}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'relation' = The relation of the property relation selection.<\/li><li>'selection' = The selection of the property relation selection.<\/li><\/ul>","format":"string","in":"query"},{"name":"relationSelectionId","type":"integer","required":true,"description":"The ID of the relation selection","format":"integer","in":"path"}]},"put":{"summary":"Update a property relation selection","description":"Updates a property relation selection. The ID of the relation selection must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyRelationSelection"},"examples":{"application\/json":{"relationId":121,"selectionId":15}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"relationSelectionId","type":"integer","required":true,"description":"The ID of the relation selection","format":"integer","in":"path"},{"in":"body","name":"\/rest\/v2\/properties\/relations\/selections\/{relationSelectionId}","schema":{"type":"object","properties":{"relationId":{"type":"integer","description":"The relation ID of the property relation selection value"},"selectionId":{"type":"integer","description":"The selection ID of the property relation selection value"}}}}]}},"\/rest\/v2\/properties\/relations\/values":{"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"},"examples":{"application\/json":{"relationId":115,"lang":"hu","value":"Et sit enim placeat magnam dolores. Ut ut commodi fugiat amet nihil. Aut placeat nihil commodi repellendus. Ut pariatur quia sequi rerum delectus officiis mollitia.","description":"A molestiae officiis autem quae vero. Illum neque officiis optio tenetur. Blanditiis autem labore id alias minima vel."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties\/relations\/values","schema":{"type":"object","properties":{"relationId":{"type":"integer","description":"The ID of the property relation"},"lang":{"type":"string","description":"The language of the property relation value allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"value":{"type":"string","description":"The value of the property relation optional"},"description":{"type":"string","description":"The description of the property relation value optional"}}}}]}},"\/rest\/v2\/properties\/relations\/values\/{relationValueId}":{"delete":{"summary":"Delete a property relation value","description":"Deletes a property relation value. The ID of the relation value must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"relationValueId","type":"integer","required":true,"description":"The ID of the relation value","format":"integer","in":"path"}]},"get":{"summary":"Get a property relation value","description":"Gets a property relation value. The ID of the relation value must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyRelationValue"},"examples":{"application\/json":{"relationId":114,"lang":"hr","value":"Dolorum iusto libero aliquid quis et qui quis. Deleniti temporibus aut ut qui corrupti. Debitis earum velit laboriosam quia.","description":"Exercitationem nemo non voluptatem quaerat. Maiores quia laudantium voluptas quia dolorum beatae. Fuga non dicta dolor molestiae voluptas natus quia."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'relation' = The relation of the property relation selection.<\/li><\/ul>","format":"string","in":"query"},{"name":"relationValueId","type":"integer","required":true,"description":"The ID of the relation value","format":"integer","in":"path"}]},"put":{"summary":"Update a property relation value","description":"Updates a property relation value. The ID of the relation value must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyRelationValue"},"examples":{"application\/json":{"relationId":116,"lang":"se","value":"Sequi ex laboriosam blanditiis id nisi qui eum labore. Accusamus et mollitia excepturi ratione nemo voluptatem qui.","description":"Illo recusandae magni deserunt aut. Blanditiis nulla porro sunt dolorum. Facilis accusamus error qui incidunt aut molestiae."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"relationValueId","type":"integer","required":true,"description":"The ID of the relation value","format":"integer","in":"path"},{"in":"body","name":"\/rest\/v2\/properties\/relations\/values\/{relationValueId}","schema":{"type":"object","properties":{"relationId":{"type":"integer","description":"The ID of the property relation"},"lang":{"type":"string","description":"The language of the property relation value allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"value":{"type":"string","description":"The value of the property relation optional"},"description":{"type":"string","description":"The description of the property relation value optional"}}}}]}},"\/rest\/v2\/properties\/relations\/{relationId}":{"delete":{"summary":"Delete a property relation","description":"Deletes a property relation. The ID of the relation must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]},"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"},"examples":{"application\/json":{"propertyId":675,"groupId":1,"type":"opportunity","targetId":6,"markup":2517.98,"value":"mollitia"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'property' = The property of the property relation.<\/li><li>'group' = The property group of the property relation.<\/li><li>'values' = The values of the property relation.<\/li><li>'selectionValues' = The selection values of the property relation.<\/li><\/ul>","format":"string","in":"query"},{"name":"relationId","type":"integer","required":true,"description":"The ID of the property","format":"integer","in":"path"}]},"put":{"summary":"Update a property relation","description":"Updates a property relation. The ID of the relation must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyRelation"},"examples":{"application\/json":{"propertyId":672,"groupId":1,"type":"contact","targetId":3,"markup":28668.91,"value":"944463795"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},{"in":"body","name":"\/rest\/v2\/properties\/relations\/{relationId}","schema":{"type":"object","properties":{"groupId":{"type":"integer","description":"The property group ID of the property relation"},"markup":{"type":"number","description":"The mark up of the property relation optional"},"value":{"type":"string","description":"The value of the property relation optional"},"selectionValues":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelationSelection"}},"selectionId":{"type":"integer","description":"The selection ID of the property relation selection value"},"values":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelationValue"}},"lang":{"type":"string","description":"The language of the property relation value allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"description":{"type":"string","description":"The description of the property relation value optional"}}}}]}},"\/rest\/v2\/properties\/relations\/{relationId}\/file":{"delete":{"summary":"Delete the file of a property relation","description":"Delete the file of a property relation. The ID of the property relation must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]},"post":{"summary":"Upload a property relation file","description":"Upload a property relation file. The ID of the property relation must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyRelation"},"examples":{"application\/json":{"propertyId":676,"groupId":1,"type":"opportunity","targetId":4,"markup":204899.21,"value":"explicabo"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/v2\/properties\/relations\/{relationId}\/selections":{"get":{"summary":"Get property relation selections by relation ID","description":"Gets property relation selections for the specified relation ID.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelationSelection"}},"examples":{"application\/json":[{"relationId":122,"selectionId":16},{"relationId":123,"selectionId":17}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'relation' = The relation of the property relation selection.<\/li><li>'selection' = The selection of the property relation selection.<\/li><\/ul>","format":"string","in":"query"},{"name":"relationId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/v2\/properties\/relations\/{relationId}\/values":{"get":{"summary":"Get property relation values by relation ID","description":"Gets property relation values for the specified relation ID.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelationValue"}},"examples":{"application\/json":[{"relationId":117,"lang":"da","value":"Magni sint sapiente omnis voluptatum sapiente sunt quis. Eligendi aliquid qui sed illum in rem ratione. Hic dolorem excepturi et consequatur.","description":"Omnis accusamus quas veniam dolorem iusto aut fugiat. Rerum eius blanditiis et. Debitis vel corrupti tempore at quod."},{"relationId":118,"lang":"fi","value":"Non quo atque quo modi saepe. Quo accusantium aspernatur inventore quod. Et maxime quam temporibus.","description":"Officia voluptatem adipisci aspernatur et odio et consequatur. Voluptatum soluta ea quam veniam. Neque asperiores eos voluptatum cupiditate a aut eligendi."}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'relation' = The relation of the property relation selection.<\/li><\/ul>","format":"string","in":"query"},{"name":"relationId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/v2\/properties\/selections":{"post":{"summary":"Create a property selection","description":"Creates a property selection. At least one selection name must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertySelection"},"examples":{"application\/json":{"propertyId":660,"position":5}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties\/selections","schema":{"type":"object","properties":{"propertyId":{"type":"integer","description":"The property ID of the property selection"},"position":{"type":"integer","description":"The position of the property selection"},"names":{"type":"array","items":{}}}}}]}},"\/rest\/v2\/properties\/selections\/names":{"post":{"summary":"Create a property selection name","description":"Creates a property selection name.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertySelectionName"},"examples":{"application\/json":{"selectionId":1,"lang":"ro","name":"Rosetta Monahan","description":"Laboriosam ratione error voluptas voluptas consequatur. Quia odio in eos voluptatibus. Ea omnis eum enim distinctio harum autem. Dicta eveniet neque quo temporibus placeat."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties\/selections\/names","schema":{"type":"object","properties":{"selectionId":{"type":"integer","description":"The selection ID of the property selection name"},"lang":{"type":"string","description":"The language of the property selection name allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"name":{"type":"string","description":"The name of the property selection name optional"},"description":{"type":"string","description":"The description of the property selection name optional"}}}}]}},"\/rest\/v2\/properties\/selections\/names\/{nameId}":{"delete":{"summary":"Delete a property selection name","description":"Deletes a property selection name. The ID of the selection name must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 selection name","format":"integer","in":"path"}]},"get":{"summary":"Get a property selection name","description":"Gets a property selection name. The ID of the selection name must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertySelectionName"},"examples":{"application\/json":{"selectionId":1,"lang":"pt","name":"Dr. Royal Boyer","description":"Autem esse velit nemo id. Qui quam quidem enim quo est id sint. Nisi in tenetur sit libero dignissimos ut."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 selection","format":"integer","in":"path"}]},"put":{"summary":"Update a property selection name","description":"Updates a property selection name. The ID of the selection name must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertySelectionName"},"examples":{"application\/json":{"selectionId":1,"lang":"es","name":"Dario Reilly","description":"Molestiae architecto praesentium vel et quaerat et voluptatem. Quo et consequuntur et eius. Sed omnis eum velit nulla hic."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 selection name","format":"integer","in":"path"},{"in":"body","name":"\/rest\/v2\/properties\/selections\/names\/{nameId}","schema":{"type":"object","properties":{"selectionId":{"type":"integer","description":"The selection ID of the property selection name"},"lang":{"type":"string","description":"The language of the property selection name allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"name":{"type":"string","description":"The name of the property selection name optional"},"description":{"type":"string","description":"The description of the property selection name optional"}}}}]}},"\/rest\/v2\/properties\/selections\/{selectionId}":{"delete":{"summary":"Delete a property selection","description":"Deletes a property selection. The ID of the selection must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"selectionId","type":"integer","required":true,"description":"The ID of the selection","format":"integer","in":"path"}]},"get":{"summary":"Get a property selection","description":"Gets a property selection. The ID of the selection must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertySelection"},"examples":{"application\/json":{"propertyId":662,"position":9}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'property' = The property of the property selection.<\/li><li>'names' = The names of the property selection.<\/li><\/ul>","format":"string","in":"query"},{"name":"selectionId","type":"integer","required":true,"description":"The ID of the selection","format":"integer","in":"path"}]},"put":{"summary":"Update a property selection","description":"Updates a property selection. The ID of the selection must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertySelection"},"examples":{"application\/json":{"propertyId":661,"position":5}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"selectionId","type":"integer","required":true,"description":"The ID of the selection","format":"integer","in":"path"},{"in":"body","name":"\/rest\/v2\/properties\/selections\/{selectionId}","schema":{"type":"object","properties":{"position":{"type":"integer","description":"The position of the property selection optional"},"names":{"type":"array","items":{}}}}}]}},"\/rest\/v2\/properties\/selections\/{selectionId}\/names":{"get":{"summary":"Get property selection names by selection ID","description":"Gets property selection names for the specified selection ID.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PropertySelectionName"}},"examples":{"application\/json":[{"selectionId":1,"lang":"se","name":"Dr. Erwin Kshlerin DDS","description":"In et non sed ullam nisi. Est aut et quo id magni. Unde ab ut non iste nesciunt harum."},{"selectionId":1,"lang":"lv","name":"Mr. Kacey Windler","description":"Iste ut ea voluptatem vero quia atque consectetur. Maxime eum quia rem iure dolorum perspiciatis. Voluptates maiores ut autem dolores amet officia."}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"selectionId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/v2\/properties\/uuid\/relations":{"get":{"summary":"Search for property relations","description":"Searches for properties relations. Filters can be specified.","tags":["Property"],"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 PropertyRelation","items":{"$ref":"#\/definitions\/PropertyRelation"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"propertyId":692,"groupId":1,"type":"contact","targetId":3,"markup":11003626.53,"value":null},{"propertyId":693,"groupId":1,"type":"item","targetId":99158,"markup":292469392,"value":null}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'property' = The property of the property relation.<\/li><li>'group' = The property group of the property relation.<\/li><li>'values' = The values of the property relation.<\/li><li>'selectionValues' = The selection values of the property relation.<\/li><\/ul>","format":"string","in":"query"},{"name":"orderBy","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.","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"},{"name":"id","type":"integer","required":false,"description":"Filter restricts the list of results to property relations which have have a matching ID. Possible search operators are: 'eq', 'in', 'gte', 'gt', 'lte', 'lt', 'between'","format":"integer","in":"query"},{"name":"propertyId","type":"string","required":false,"description":"Filter restricts the list of results to property relations which have have a matching propertyId. Possible search operators are: 'eq', 'in', 'gte', 'gt', 'lte', 'lt', 'between'","format":"string","in":"query"},{"name":"targetId","type":"integer","required":false,"description":"Filter restricts the list of results to property relations which have have a matching target id. Possible search operators are: 'eq', 'in', 'gte', 'gt', 'lte', 'lt', 'between'","format":"integer","in":"query"},{"name":"property.cast","type":"string","required":false,"description":"Filter restricts the list of results to property relations which have have a matching proeprty cast. Possible search operators are: 'eq', 'in'","format":"string","in":"query"},{"name":"type","type":"string","required":false,"description":"Filter restricts the list of results to property relations which have have a matching type. Possible search operators are: 'eq', 'in'","format":"string","in":"query"},{"name":"updatedAt","type":"string","required":false,"description":"Filter restricts the list of results to property relations which have a matching updatedAt. Possible search operators are: 'between', 'gte', 'lte', 'gt', 'lt'.","format":"string","in":"query"}]},"post":{"summary":"Create a list of property relations","description":"Creates a list of property relations.","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":[{"in":"body","name":"\/rest\/v2\/properties\/uuid\/relations","schema":{"type":"object","properties":{"propertyId":{"type":"integer","description":"The property ID of the property relation"},"type":{"type":"string","description":"The type of the property relation allowed values are item, stock, contact, opportunity"},"targetId":{"type":"integer","description":"The ID of the target of the property relation"},"groupId":{"type":"integer","description":"The property group ID of the property relation"},"markup":{"type":"number","description":"The mark up of the property relation optional"},"value":{"type":"string","description":"The value of the property relation optional"},"selectionValues":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelationSelection"}},"selectionId":{"type":"integer","description":"The selection ID of the property relation selection value"},"values":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelationValue"}},"lang":{"type":"string","description":"The language of the property relation value allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"description":{"type":"string","description":"The description of the property relation value optional"}}}}]},"put":{"summary":"Update a list of property relations","description":"Updates a list of property relations. The ID of the each relation must be specified.","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":[{"in":"body","name":"\/rest\/v2\/properties\/uuid\/relations","schema":{"type":"object","properties":{"groupId":{"type":"integer","description":"The property group ID of the property relation"},"markup":{"type":"number","description":"The mark up of the property relation optional"},"value":{"type":"string","description":"The value of the property relation optional"},"selectionValues":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelationSelection"}},"selectionId":{"type":"integer","description":"The selection ID of the property relation selection value"},"values":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelationValue"}},"lang":{"type":"string","description":"The language of the property relation value allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"description":{"type":"string","description":"The description of the property relation value optional"}}}}]}},"\/rest\/v2\/properties\/uuid\/relations\/selections":{"post":{"summary":"Create a property relation selection","description":"Creates a property relation selection.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyRelationSelection"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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\/v2\/properties\/uuid\/relations\/selections","schema":{"type":"object","properties":{"relationId":{"type":"integer","description":"The relation ID of the property relation selection value"},"selectionId":{"type":"integer","description":"The selection ID of the property relation selection value"}}}}]}},"\/rest\/v2\/properties\/uuid\/relations\/selections\/{relationSelectionId}":{"delete":{"summary":"Delete a property relation selection","description":"Deletes a property relation selection. The ID of the relation selection must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"relationSelectionId","type":"integer","required":true,"description":"The ID of the relation selection","format":"integer","in":"path"}]},"get":{"summary":"Get a property relation selection","description":"Gets a property relation selection. The ID of the relation selection must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyRelationSelection"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'relation' = The relation of the property relation selection.<\/li><li>'selection' = The selection of the property relation selection.<\/li><\/ul>","format":"string","in":"query"},{"name":"relationSelectionId","type":"integer","required":true,"description":"The ID of the relation selection","format":"integer","in":"path"}]},"put":{"summary":"Update a property relation selection","description":"Updates a property relation selection. The ID of the relation selection must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/PropertyRelationSelection"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"relationSelectionId","type":"integer","required":true,"description":"The ID of the relation selection","format":"integer","in":"path"},{"in":"body","name":"\/rest\/v2\/properties\/uuid\/relations\/selections\/{relationSelectionId}","schema":{"type":"object","properties":{"relationId":{"type":"integer","description":"The relation ID of the property relation selection value"},"selectionId":{"type":"integer","description":"The selection ID of the property relation selection value"}}}}]}},"\/rest\/v2\/properties\/uuid\/relations\/values":{"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":[{"in":"body","name":"\/rest\/v2\/properties\/uuid\/relations\/values","schema":{"type":"object","properties":{"relationId":{"type":"integer","description":"The ID of the property relation"},"lang":{"type":"string","description":"The language of the property relation value allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"value":{"type":"string","description":"The value of the property relation optional"},"description":{"type":"string","description":"The description of the property relation value optional"}}}}]}},"\/rest\/v2\/properties\/uuid\/relations\/values\/{relationValueId}":{"delete":{"summary":"Delete a property relation value","description":"Deletes a property relation value. The ID of the relation value must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"relationValueId","type":"integer","required":true,"description":"The ID of the relation value","format":"integer","in":"path"}]},"get":{"summary":"Get a property relation value","description":"Gets a property relation value. The ID of the 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":"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:<ul><li>'relation' = The relation of the property relation selection.<\/li><\/ul>","format":"string","in":"query"},{"name":"relationValueId","type":"integer","required":true,"description":"The ID of the relation value","format":"integer","in":"path"}]},"put":{"summary":"Update a property relation value","description":"Updates a property relation value. The ID of the 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":"relationValueId","type":"integer","required":true,"description":"The ID of the relation value","format":"integer","in":"path"},{"in":"body","name":"\/rest\/v2\/properties\/uuid\/relations\/values\/{relationValueId}","schema":{"type":"object","properties":{"relationId":{"type":"integer","description":"The ID of the property relation"},"lang":{"type":"string","description":"The language of the property relation value allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"value":{"type":"string","description":"The value of the property relation optional"},"description":{"type":"string","description":"The description of the property relation value optional"}}}}]}},"\/rest\/v2\/properties\/uuid\/relations\/{relationId}":{"delete":{"summary":"Delete a property relation","description":"Deletes a property relation. The ID of the relation must be specified.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]},"get":{"summary":"Get a property uuid relation","description":"Gets a property uuid relation. The ID of the property 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":"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:<ul><li>'property' = The property of the property relation.<\/li><li>'group' = The property group of the property relation.<\/li><li>'values' = The values of the property relation.<\/li><li>'selectionValues' = The selection values of the property relation.<\/li><\/ul>","format":"string","in":"query"},{"name":"relationId","type":"integer","required":true,"description":"The ID of the property","format":"integer","in":"path"}]},"put":{"summary":"Update a property relation","description":"Updates a property relation. The ID of the 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"},{"in":"body","name":"\/rest\/v2\/properties\/uuid\/relations\/{relationId}","schema":{"type":"object","properties":{"groupId":{"type":"integer","description":"The property group ID of the property relation"},"markup":{"type":"number","description":"The mark up of the property relation optional"},"value":{"type":"string","description":"The value of the property relation optional"},"selectionValues":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelationSelection"}},"selectionId":{"type":"integer","description":"The selection ID of the property relation selection value"},"values":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelationValue"}},"lang":{"type":"string","description":"The language of the property relation value allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn, fi, ga, lt, lv, et, hr, hu"},"description":{"type":"string","description":"The description of the property relation value optional"}}}}]}},"\/rest\/v2\/properties\/uuid\/relations\/{relationId}\/selections":{"get":{"summary":"Get property relation selections by relation ID","description":"Gets property relation selections for the specified relation ID.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PropertyRelationSelection"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'relation' = The relation of the property relation selection.<\/li><li>'selection' = The selection of the property relation selection.<\/li><\/ul>","format":"string","in":"query"},{"name":"relationId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/v2\/properties\/uuid\/relations\/{relationId}\/values":{"get":{"summary":"Get property relation values by relation ID","description":"Gets property relation values for the specified relation ID.","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."}},"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:<ul><li>'relation' = The relation of the property relation selection.<\/li><\/ul>","format":"string","in":"query"},{"name":"relationId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/v2\/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","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},"examples":{"application\/json":{"cast":"file","type":"opportunity","position":7}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},{"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:<ul><li>'names' = The names of the property.<\/li><li>'amazon' = The amazon values of the property.<\/li><li>'options' = The options of the property.<\/li><li>'groups' = The groups of the property.<\/li><\/ul>","format":"string","in":"query"}]},"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"},"examples":{"application\/json":{"cast":"string","type":"opportunity","position":8}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"},{"in":"body","name":"\/rest\/v2\/properties\/{propertyId}","schema":{"type":"object","properties":{"cast":{"type":"string","description":"The cast of the property (array values: 'empty','int','float','string','selection','text','html','date','file') allowed values are int, float, empty, string, text, html, selection, multiSelection, file, date"},"type":{"type":"string","description":"The type of the property (e.g. 'item' or 'contact') allowed values are item, stock, contact, opportunity"},"position":{"type":"integer","description":"The position of the property"},"names":{"type":"array","items":{}},"groups":{"type":"array","items":{}},"options":{"type":"array","items":{}},"amazon":{"type":"array","items":{"$ref":"#\/definitions\/PropertyAmazon"}},"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"}}}}]}},"\/rest\/v2\/properties\/{propertyId}\/amazon":{"get":{"summary":"Get property amazons by property ID","description":"Gets property amazons for the specified property ID.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PropertyAmazon"}},"examples":{"application\/json":[{"propertyId":1,"platform":"da","category":"ipsa","field":"ratione"},{"propertyId":1,"platform":"se","category":"quod","field":"dicta"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/v2\/properties\/{propertyId}\/names":{"get":{"summary":"Get property names by property ID","description":"Gets property names for the specified property ID.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PropertyName"}},"examples":{"application\/json":[{"propertyId":651,"lang":"lv","name":"Ralph Harber"},{"propertyId":652,"lang":"nn","name":"Nicole Flatley"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/v2\/properties\/{propertyId}\/options":{"get":{"summary":"Get property options by property ID","description":"Gets property options for the specified property ID.","tags":["Property"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/PropertyOption"}},"examples":{"application\/json":[{"propertyId":656,"type":"clients","value":"Prof. Antonia Von"},{"propertyId":657,"type":"vatId","value":"Jada Grimes IV"}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'property' = The property of the property option.<\/li><\/ul>","format":"string","in":"query"},{"name":"type","type":"string","required":false,"description":"Filter restricts the list of results to properties which have have a matching type. Possible search operators are: 'eq', 'in'","format":"string","in":"query"},{"name":"propertyId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/v2\/properties\/{propertyId}\/selections":{"get":{"summary":"Get property selections by property ID","description":"Gets property selections for the specified property ID.","tags":["Property"],"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 PropertySelection","items":{"$ref":"#\/definitions\/PropertySelection"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"propertyId":658,"position":8},{"propertyId":659,"position":5}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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:<ul><li>'property' = The property of the property selection.<\/li><li>'names' = The names of the property selection.<\/li><\/ul>","format":"string","in":"query"},{"name":"orderBy","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.","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"},{"name":"id","type":"string","required":false,"description":"Filter restricts the list of results to property selections which have have a matching id. Possible search operators are: 'eq', 'in', 'gte', 'gt', 'lte', 'lt', 'between'","format":"string","in":"query"},{"name":"name","type":"string","required":false,"description":"Filter restricts the list of results to property selections which have have a matching name. Possible search operators are: 'eq', 'like'","format":"string","in":"query"},{"name":"updatedAt","type":"string","required":false,"description":"Filter restricts the list of results to property selections which have a matching updatedAt. Possible search operators are: 'between', 'gte', 'lte', 'gt', 'lt'.","format":"string","in":"query"},{"name":"propertyId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/v2\/tags":{"get":{"summary":"List tags","description":"Lists all tags. The results can be filtered.","tags":["Tag"],"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 Tag","items":{"$ref":"#\/definitions\/Tag"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"id":95634,"name":"LightSteelBlue","color":"#552534"},{"id":67804,"name":"SaddleBrown","color":"#d6d7b6"}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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. Allowed operators: `eq` and `in`.","format":"integer","in":"query"},{"name":"name","type":"string","required":true,"description":"The name of the tag. Allowed operators: `eq` and `in`.","format":"string","in":"query"},{"name":"availability","type":"string","required":true,"description":"The availability of the tag. Allowed operators: `eq` and `in`.","format":"string","in":"query"},{"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:<ul><li>'names' = The names of the tag.<\/li><li>'clients' = The clients of the tag (only if the availability `variation` is set).<\/li><li>'availabilities' = The availabilities of the tag.<\/li><\/ul>","format":"string","in":"query"},{"name":"orderBy","type":"string","required":false,"description":"The field to order the results by.","format":"string","in":"query"},{"name":"lang","type":"string","required":false,"description":"The language to use when ordering by name.","format":"string","in":"query"}]},"post":{"summary":"Create a new tag","description":"Creates a new tag.","tags":["Tag"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Tag"},"examples":{"application\/json":{"id":69366,"name":"DimGrey","color":"#989ef5"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/v2\/tags\/names\/{id}":{"delete":{"summary":"Delete a tag name","description":"Deletes a tag name. The ID of the tag name must be specified.","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 name","format":"integer","in":"path"}]}},"\/rest\/v2\/tags\/relationships":{"get":{"summary":"List tag relationships","description":"Lists all tag relationships. The result can be filtered.\n\ntagId\ntype\nvalue","tags":["Tag"],"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 TagRelationship","items":{"$ref":"#\/definitions\/TagRelationship"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"id":81890,"tagId":30615,"type":"board","value":2},{"id":16297,"tagId":79533,"type":"documentTemplate","value":5}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 tag relationship","description":"Creates a tag relationship. The ID of the tag, the type of the relation and a value must be specified.","tags":["Tag"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/TagRelationship"},"examples":{"application\/json":{"id":66474,"tagId":20683,"type":"category","value":7}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/v2\/tags\/relationships\/{relationshipId}":{"delete":{"summary":"Delete a tag relationship","description":"Deletes a tag relationship. The ID of the tag relationship must be specified.","tags":["Tag"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"relationshipId","type":"integer","required":true,"description":"The ID of the tag relationship","format":"integer","in":"path"}]}},"\/rest\/v2\/tags\/{tagId}":{"delete":{"summary":"Delete a tag","description":"Deletes a tag. The ID of the tag must be specified.","tags":["Tag"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":true,"description":"The ID of the tag","format":"integer","in":"path"}]},"get":{"summary":"Get one tag","description":"Gets one tag. The ID must be specified.","tags":["Tag"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Tag"},"examples":{"application\/json":{"id":51957,"name":"Brown","color":"#50677c"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":true,"description":"The ID of the tag","format":"integer","in":"path"},{"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:<ul><li>'names' = The names of the tag.<\/li><li>'clients' = The clients of the tag (only if the availability `variation` is set).<\/li><li>'availabilities' = The availabilities of the tag.<\/li><\/ul>","format":"string","in":"query"}]},"put":{"summary":"Update an existing tag","description":"Updates an existing tag. The ID of the tag must be specified.","tags":["Tag"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Tag"},"examples":{"application\/json":{"id":86895,"name":"PaleVioletRed","color":"#164690"}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":true,"description":"The ID of the tag","format":"integer","in":"path"}]}},"\/rest\/vat":{"get":{"summary":"List VAT configurations.","description":"Lists the VAT configurations for the given filter. Possible filters are <code>locationId<\/code>, <code>countryId<\/code>, <code>taxIdNumber<\/code> and <code>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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"taxIdNumber":"DE123456789","startedAt":"2014-05-25T00:00:00+02:00","invalidFrom":"1985-03-02T00:00:00+01:00","isRestrictedToDigitalItems":false,"marginScheme":"vat3","locationId":15,"countryId":305,"vatRates":[{"id":0,"name":"enim","vatRate":12.73,"revenueAccount":"3797"},{"id":1,"name":"vel","vatRate":8.44,"revenueAccount":"1792"},{"id":2,"name":"laudantium","vatRate":12.15,"revenueAccount":"4309"},{"id":3,"name":"est","vatRate":15.35,"revenueAccount":"5721"},{"id":4,"name":"quaerat","vatRate":16,"revenueAccount":"9276"},{"id":5,"name":"nostrum","vatRate":25.21,"revenueAccount":"6264"}]},{"taxIdNumber":"DE123456789","startedAt":"2003-12-24T00:00:00+01:00","invalidFrom":"1993-11-24T00:00:00+01:00","isRestrictedToDigitalItems":false,"marginScheme":"vat5","locationId":16,"countryId":306,"vatRates":[{"id":0,"name":"qui","vatRate":16.88,"revenueAccount":"8384"},{"id":1,"name":"harum","vatRate":10.83,"revenueAccount":"5339"},{"id":2,"name":"eaque","vatRate":24.4,"revenueAccount":"7821"},{"id":3,"name":"sunt","vatRate":11.34,"revenueAccount":"4239"},{"id":4,"name":"deleniti","vatRate":15.76,"revenueAccount":"7949"},{"id":5,"name":"at","vatRate":5.66,"revenueAccount":"5579"}]}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The relations to load with the VAT object. The relations available are location or country.","format":"","in":"query","items":{"type":"string"}},{"name":"columns","type":"array","required":false,"description":"The properties to be loaded.","format":"","in":"query","items":{"type":"string"}}]},"post":{"summary":"Create a VAT configuration","description":"Create a new VAT configuration","tags":["Accounting"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Vat"},"examples":{"application\/json":{"taxIdNumber":"DE123456789","startedAt":"1979-10-12T00:00:00+01:00","invalidFrom":"1999-12-07T00:00:00+01:00","isRestrictedToDigitalItems":false,"marginScheme":"vat1","locationId":19,"countryId":309,"vatRates":[{"id":0,"name":"tempora","vatRate":16.13,"revenueAccount":"6025"},{"id":1,"name":"necessitatibus","vatRate":10.51,"revenueAccount":"6317"},{"id":2,"name":"voluptatem","vatRate":7.81,"revenueAccount":"7908"},{"id":3,"name":"doloremque","vatRate":6.58,"revenueAccount":"2659"},{"id":4,"name":"neque","vatRate":18.83,"revenueAccount":"9635"},{"id":5,"name":"dolorum","vatRate":27.98,"revenueAccount":"2972"}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing 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","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."},"economicIdNumber":{"type":"string","description":"The economic 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, vat4, vat5"},"vatRates":{"type":"array","items":{"$ref":"#\/definitions\/VatRate"}},"id":{"type":"integer","description":"The ID of the VAT rate allowed values are 0, 1, 2, 3, 4, 5"},"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 %"},"revenueAccount":{"type":"string","description":"The revenue account for the VAT rate"}}}}]}},"\/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":"array","required":false,"description":"The relations to load with the VAT object. The relations available are location and country.","format":"","in":"query","items":{"type":"string"}},{"name":"columns[]","type":"array","required":false,"description":"The attributes of the VAT configuration","format":"","in":"query","items":{"type":"string"}}]}},"\/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"}},"examples":{"application\/json":[{"taxIdNumber":"DE123456789","startedAt":"2006-02-10T00:00:00+01:00","invalidFrom":"1976-10-04T00:00:00+01:00","isRestrictedToDigitalItems":false,"marginScheme":"vat5","locationId":12,"countryId":302,"vatRates":[{"id":0,"name":"eaque","vatRate":5.63,"revenueAccount":"6263"},{"id":1,"name":"et","vatRate":9.12,"revenueAccount":"4612"},{"id":2,"name":"eligendi","vatRate":25.35,"revenueAccount":"5025"},{"id":3,"name":"facere","vatRate":8.4,"revenueAccount":"8785"},{"id":4,"name":"eum","vatRate":13.25,"revenueAccount":"6284"},{"id":5,"name":"sit","vatRate":25.37,"revenueAccount":"1642"}]},{"taxIdNumber":"DE123456789","startedAt":"1971-09-02T00:00:00+01:00","invalidFrom":"2025-09-05T00:00:00+02:00","isRestrictedToDigitalItems":false,"marginScheme":"vat1","locationId":13,"countryId":303,"vatRates":[{"id":0,"name":"voluptate","vatRate":26.15,"revenueAccount":"4250"},{"id":1,"name":"qui","vatRate":11.92,"revenueAccount":"5958"},{"id":2,"name":"vel","vatRate":6.23,"revenueAccount":"2399"},{"id":3,"name":"quis","vatRate":28.52,"revenueAccount":"8984"},{"id":4,"name":"magni","vatRate":18.86,"revenueAccount":"8440"},{"id":5,"name":"vel","vatRate":7.43,"revenueAccount":"2465"}]}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The relations to load with the VAT object. The relations available are location or country.","format":"","in":"query","items":{"type":"string"}},{"name":"columns[]","type":"array","required":false,"description":"The attributes of the VAT configuration","format":"","in":"query","items":{"type":"string"}}]}},"\/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"},"examples":{"application\/json":{"taxIdNumber":"DE123456789","startedAt":"2018-12-13T00:00:00+01:00","invalidFrom":"2016-06-28T00:00:00+02:00","isRestrictedToDigitalItems":false,"marginScheme":"vat0","locationId":14,"countryId":304,"vatRates":[{"id":0,"name":"ipsam","vatRate":20.59,"revenueAccount":"6620"},{"id":1,"name":"quia","vatRate":26.72,"revenueAccount":"9952"},{"id":2,"name":"optio","vatRate":18.58,"revenueAccount":"5716"},{"id":3,"name":"aspernatur","vatRate":19.95,"revenueAccount":"5293"},{"id":4,"name":"alias","vatRate":10.9,"revenueAccount":"7705"},{"id":5,"name":"ut","vatRate":5.56,"revenueAccount":"4664"}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":false,"description":"The relations to load with the VAT object. The relations available are location or country.","format":"","in":"query","items":{"type":"string"}},{"name":"columns[]","type":"array","required":false,"description":"The attributes of the VAT configuration","format":"","in":"query","items":{"type":"string"}},{"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"},"examples":{"application\/json":{"taxIdNumber":"DE123456789","startedAt":"2012-01-10T00:00:00+01:00","invalidFrom":"2001-11-01T00:00:00+01:00","isRestrictedToDigitalItems":false,"marginScheme":"vat3","locationId":17,"countryId":307,"vatRates":[{"id":0,"name":"et","vatRate":14.39,"revenueAccount":"6161"},{"id":1,"name":"vero","vatRate":5.19,"revenueAccount":"1635"},{"id":2,"name":"provident","vatRate":21.65,"revenueAccount":"1996"},{"id":3,"name":"nobis","vatRate":16.14,"revenueAccount":"2061"},{"id":4,"name":"a","vatRate":5.65,"revenueAccount":"9154"},{"id":5,"name":"odit","vatRate":27.5,"revenueAccount":"7957"}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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}":{"delete":{"summary":"Delete a VAT configuration","description":"Deletes a VAT configuration. The VAT ID must be specified.","tags":["Accounting"],"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":"vatId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]},"get":{"summary":"Get a VAT configuration by id","description":"Get a VAT configuration by id.","tags":["Accounting"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Vat"},"examples":{"application\/json":{"taxIdNumber":"DE123456789","startedAt":"1995-10-14T00:00:00+01:00","invalidFrom":"2009-04-19T00:00:00+02:00","isRestrictedToDigitalItems":false,"marginScheme":"vat5","locationId":18,"countryId":308,"vatRates":[{"id":0,"name":"animi","vatRate":26.92,"revenueAccount":"1116"},{"id":1,"name":"dolore","vatRate":23.56,"revenueAccount":"8983"},{"id":2,"name":"et","vatRate":11.36,"revenueAccount":"6589"},{"id":3,"name":"aut","vatRate":25.71,"revenueAccount":"1751"},{"id":4,"name":"mollitia","vatRate":16.64,"revenueAccount":"6879"},{"id":5,"name":"aliquam","vatRate":8.41,"revenueAccount":"8616"}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"Update a VAT configuration.","tags":["Accounting"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Vat"},"examples":{"application\/json":{"taxIdNumber":"DE123456789","startedAt":"1973-02-16T00:00:00+01:00","invalidFrom":"2002-01-26T00:00:00+01:00","isRestrictedToDigitalItems":false,"marginScheme":"vat3","locationId":20,"countryId":310,"vatRates":[{"id":0,"name":"perspiciatis","vatRate":11.19,"revenueAccount":"7781"},{"id":1,"name":"soluta","vatRate":15.53,"revenueAccount":"6591"},{"id":2,"name":"quos","vatRate":29.83,"revenueAccount":"1450"},{"id":3,"name":"incidunt","vatRate":29.79,"revenueAccount":"6721"},{"id":4,"name":"eum","vatRate":26.98,"revenueAccount":"1199"},{"id":5,"name":"non","vatRate":22.06,"revenueAccount":"5743"}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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","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."},"economicIdNumber":{"type":"string","description":"The economic 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, vat4, vat5"},"vatRates":{"type":"array","items":{"$ref":"#\/definitions\/VatRate"}},"id":{"type":"integer","description":"The ID of the VAT rate allowed values are 0, 1, 2, 3, 4, 5"},"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 %"},"revenueAccount":{"type":"string","description":"The revenue account for the VAT rate"}}}}]}},"\/rest\/warehouses":{"get":{"summary":"List warehouses","description":"Lists all warehouses. The results can be filtered.","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 Warehouse","items":{"$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":"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:<ul><li>'repairWarehouse' = Associated repair warehouse.<\/li><li>'storageLocations' = The storage locations of the warehouse.<\/li><li>'dimensions' = The dimensions of the warehouse<\/li><\/ul>","format":"string","in":"query"},{"name":"id","type":"integer","required":false,"description":"The ID of the warehouse. Allowed operators: `eq`, `not`, `in`, `nin`","format":"integer","in":"query"},{"name":"name","type":"string","required":false,"description":"The name of the warehouse. Allowed operators: `eq`, `not`, `in`, `nin`, `like`","format":"string","in":"query"},{"name":"priority","type":"integer","required":false,"description":"The priority of the warehouse. Allowed operators: `eq`, `not`, `in`, `nin`, `lt`, `lte`, `gt`, `gte`, `between`","format":"integer","in":"query"}]},"post":{"summary":"Create a new warehouse","description":"Creates a new warehouse.","tags":["Warehouse"],"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."}}}},"\/rest\/warehouses\/layouts":{"post":{"summary":"Create a storage location layout","description":"Creates a storage location layout","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/WarehouseLocationDimension"},"examples":{"application\/json":{"parentId":6,"warehouseId":754836560,"level":207,"name":"Voluptatem eum facere labore ut voluptatem.","displayInName":false,"shortcut":"Tenetur id sit.","separator":"\/","isActiveForPickupPath":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 storage location dimension","format":"integer","in":"query"},{"name":"warehouseId","type":"integer","required":true,"description":"The warehouse ID of the storage location dimension","format":"integer","in":"query"},{"name":"level","type":"integer","required":true,"description":"The level of the storage location dimension","format":"integer","in":"query"},{"name":"name","type":"string","required":true,"description":"The name of the storage location dimension","format":"string","in":"query"},{"name":"shortcut","type":"string","required":true,"description":"The shortcut of the storage location dimension","format":"string","in":"query"},{"name":"separator","type":"string","required":true,"description":"The separator of the storage location dimension","format":"string","in":"query"},{"name":"isActiveForPickupPath","type":"integer","required":true,"description":"Active flag for pickup path of the storage location dimension","format":"integer","in":"query"},{"name":"dimensionId","type":"integer","required":true,"description":"The storage location dimension ID of the storage location level","format":"integer","in":"query"},{"name":"position","type":"integer","required":true,"description":"The position of the storage location level","format":"integer","in":"query"},{"name":"levelId","type":"integer","required":true,"description":"The storage location level ID of the storage location","format":"integer","in":"query"},{"name":"label","type":"string","required":true,"description":"The label of the storage location","format":"string","in":"query"},{"name":"purposeKey","type":"string","required":true,"description":"The location type key of the storage location","format":"string","in":"query"},{"name":"statusKey","type":"string","required":true,"description":"The location status key of the storage location","format":"string","in":"query"}]}},"\/rest\/warehouses\/locations":{"delete":{"summary":"Delete multiple storage locations","description":"Deletes multiple storage 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":"array","required":true,"description":"An array containing all the ID's for the storage locations that need to be deleted","format":"","in":"query","items":{"type":"string"}}]},"get":{"summary":"List storage locations","description":"Lists all storage 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"label":"Repellendus.","purposeKey":"Quas ea.","statusKey":"Iure odio.","position":3,"type":"medium","fullLabel":"Repellendus.","warehouseLocationLevel":null},{"label":"Error dolore.","purposeKey":"Aut.","statusKey":"Labore sapiente.","position":0,"type":"large","fullLabel":"Error dolore.","warehouseLocationLevel":null}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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 storage location","description":"Creates a storage location.","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/WarehouseLocation"},"examples":{"application\/json":{"label":"Sunt.","purposeKey":"Id corrupti.","statusKey":"A.","position":7,"type":"medium","fullLabel":"Sunt.","warehouseLocationLevel":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 storage location level ID of the storage location","format":"integer","in":"query"},{"name":"label","type":"string","required":true,"description":"The label of the storage location","format":"string","in":"query"},{"name":"purposeKey","type":"string","required":true,"description":"The location type key of the storage location","format":"string","in":"query"},{"name":"statusKey","type":"string","required":true,"description":"The location status key of the storage location","format":"string","in":"query"},{"name":"position","type":"integer","required":true,"description":"The position of the storage 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 storage location","format":"integer","in":"path"}]}},"\/rest\/warehouses\/locations\/details":{"get":{"summary":"Get storage location details","description":"Gets storage 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 storage location dimension","description":"Creates a storage location dimension.","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/WarehouseLocationDimension"},"examples":{"application\/json":{"parentId":8,"warehouseId":858856859,"level":77,"name":"Reiciendis dicta eum ipsum dolore dolore.","displayInName":false,"shortcut":"Ullam tempora.","separator":"_","isActiveForPickupPath":false}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 storage location dimension","format":"integer","in":"query"},{"name":"warehouseId","type":"integer","required":true,"description":"The warehouse ID of the storage location dimension","format":"integer","in":"query"},{"name":"level","type":"integer","required":true,"description":"The level of the storage location dimension","format":"integer","in":"query"},{"name":"name","type":"string","required":true,"description":"The name of the storage location dimension","format":"string","in":"query"},{"name":"shortcut","type":"string","required":true,"description":"The shortcut of the storage location dimension","format":"string","in":"query"},{"name":"separator","type":"string","required":true,"description":"The separator of the storage location dimension","format":"string","in":"query"},{"name":"isActiveForPickupPath","type":"integer","required":true,"description":"Active flag for pickup path of the storage location dimension","format":"integer","in":"query"}]}},"\/rest\/warehouses\/locations\/dimensions\/{warehouseLocationDimensionId}":{"delete":{"summary":"Delete a storage location dimension","description":"Deletes a storage 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 storage location dimension","format":"integer","in":"path"}]},"get":{"summary":"Get a storage location dimension","description":"Gets a storage location dimension by ID. The storage location ID is required.","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/WarehouseLocationDimension"},"examples":{"application\/json":{"parentId":1,"warehouseId":482981356,"level":107,"name":"Consequuntur porro quaerat iste recusandae ut.","displayInName":true,"shortcut":"Aut accusamus.","separator":"-","isActiveForPickupPath":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 storage location dimension","format":"integer","in":"path"}]},"put":{"summary":"Update a storage location dimension","description":"Updates a storage location dimension","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/WarehouseLocationDimension"},"examples":{"application\/json":{"parentId":7,"warehouseId":375430636,"level":183,"name":"Amet praesentium ut dolorum dolor quod.","displayInName":true,"shortcut":"Et sint.","separator":"@","isActiveForPickupPath":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 storage location dimension","format":"integer","in":"path"},{"name":"name","type":"string","required":false,"description":"The name of the storage location dimension","format":"string","in":"query"},{"name":"displayInName","type":"boolean","required":false,"description":"The display in name flag of the storage location dimension","format":"boolean","in":"query"},{"name":"shortcut","type":"string","required":false,"description":"The shortcut of the storage location dimension","format":"string","in":"query"},{"name":"separator","type":"string","required":false,"description":"The separator of the storage location dimension","format":"string","in":"query"},{"name":"isActiveForPickupPath","type":"boolean","required":false,"description":"Active flag for pickup path of the storage location dimension","format":"boolean","in":"query"}]}},"\/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"}},"examples":{"application\/json":[{"label":"Facilis.","purposeKey":"Omnis beatae.","statusKey":"Molestiae architecto.","position":6,"type":"europallet","fullLabel":"Facilis.","warehouseLocationLevel":null},{"label":"Quaerat.","purposeKey":"Consequatur voluptatem.","statusKey":"Odit ullam.","position":2,"type":"small","fullLabel":"Quaerat.","warehouseLocationLevel":null}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 storage location purposeKey field","format":"string","in":"query"},{"name":"status","type":"string","required":true,"description":"The status key value for storage location status field","format":"string","in":"query"}]}},"\/rest\/warehouses\/locations\/inventory":{"post":{"summary":"Create a storage location inventory","description":"Creates a storage location inventory.","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/WarehouseLocationInventory"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"access token\" parameter."}},"parameters":[{"name":"status","type":"integer","required":true,"description":"The storage location inventory status","format":"integer","in":"query"}]}},"\/rest\/warehouses\/locations\/inventory\/list":{"get":{"summary":"Get a storage location list of inventories","description":"Gets a storage location list of inventories by storage location id. The storage location ID is required.","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 WarehouseLocationInventory","items":{"$ref":"#\/definitions\/WarehouseLocationInventory"}}}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/inventory\/{warehouseLocationInventoryId}":{"get":{"summary":"Get a storage location inventory","description":"Gets a storage location inventory by ID. The storage location inventory ID is required.","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/WarehouseLocationInventory"}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 storage location","format":"integer","in":"query"},{"name":"warehouseLocationInventoryId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/warehouses\/locations\/levels":{"post":{"summary":"Create a storage location level","description":"Creates a storage location level.","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/WarehouseLocationLevel"},"examples":{"application\/json":{"parentId":0,"position":3,"pickupPathPosition":7,"pathName":"Dicta.","name":"Perferendis accusamus ut adipisci sit odio."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 storage location level","format":"integer","in":"query"},{"name":"dimensionId","type":"integer","required":true,"description":"The storage location dimension ID of the storage location level","format":"integer","in":"query"},{"name":"position","type":"integer","required":true,"description":"The position of the storage location level","format":"integer","in":"query"},{"name":"name","type":"string","required":true,"description":"The name of the storage location level","format":"string","in":"query"}]}},"\/rest\/warehouses\/locations\/levels\/positions":{"post":{"summary":"Move a storage location level position","description":"Moves a storage 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 storage location level ID that needs needs to be moved","format":"integer","in":"query"},{"name":"target","type":"integer","required":true,"description":"The storage location level ID that stands as position for the storage 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 storage location level","description":"Deletes a storage 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 storage location level","format":"integer","in":"path"}]},"get":{"summary":"Get a storage location level","description":"Gets a storage location level by ID. The storage location ID is required.","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/WarehouseLocationLevel"},"examples":{"application\/json":{"parentId":1,"position":6,"pickupPathPosition":5,"pathName":"Accusantium in.","name":"Dolore quod eligendi dolorem quaerat similique."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 storage location level","format":"integer","in":"path"}]},"put":{"summary":"Update a storage location level","description":"Updates a storage location level","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/WarehouseLocationLevel"},"examples":{"application\/json":{"parentId":9,"position":7,"pickupPathPosition":4,"pathName":"Dolores distinctio.","name":"Consectetur quas eos et velit."}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 storage location level","format":"integer","in":"path"}]}},"\/rest\/warehouses\/locations\/multiple_dimensions":{"post":{"summary":"Create multiple storage location dimensions","description":"Creates multiple storage location dimension.","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/WarehouseLocationDimension"}},"examples":{"application\/json":[{"parentId":8,"warehouseId":396509090,"level":120,"name":"Totam assumenda culpa voluptate.","displayInName":false,"shortcut":"Minus quasi molestias.","separator":"_","isActiveForPickupPath":false},{"parentId":4,"warehouseId":857831202,"level":178,"name":"Velit voluptatem asperiores at laudantium vel.","displayInName":false,"shortcut":"Ut quod quaerat.","separator":"\/","isActiveForPickupPath":true}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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":"array","required":true,"description":"The dimensions array that contains data for creating multiple dimensions","format":"","in":"query","items":{"type":"string"}}]}},"\/rest\/warehouses\/locations\/positions":{"post":{"summary":"Move a storage location position","description":"Moves a storage 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 storage location ID that needs needs to be moved","format":"integer","in":"query"},{"name":"target","type":"integer","required":true,"description":"The storage location ID that stands as position for the storage 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 storage location preview and saves it","description":"Generates storage 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":"array","required":true,"description":"The storage location dimensions used by the generator","format":"","in":"query","items":{"type":"string"}},{"name":"storageLocationData","type":"array","required":true,"description":"The storage location data used by the generator","format":"","in":"query","items":{"type":"string"}},{"name":"levelData","type":"array","required":true,"description":"The storage location level data used by the generator","format":"","in":"query","items":{"type":"string"}},{"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 storage locations stock","description":"Lists all storage 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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"label":"Pariatur.","purposeKey":"Quos.","statusKey":"Aspernatur.","position":8,"type":"large","fullLabel":"Pariatur.","warehouseLocationLevel":null},{"label":"Repellendus ducimus.","purposeKey":"Distinctio.","statusKey":"Magnam odio.","position":7,"type":"large","fullLabel":"Repellendus ducimus.","warehouseLocationLevel":null}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 storage location label","description":"Generates the storage 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 storage location ID's for which a label needs to be generated","format":"string","in":"query"}]}},"\/rest\/warehouses\/locations\/{warehouseLocationId}":{"delete":{"summary":"Delete a storage location","description":"Deletes a storage 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 storage location","format":"integer","in":"path"}]},"get":{"summary":"Get a storage location","description":"Gets a storage location by ID. The storage location ID is required.","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/WarehouseLocation"},"examples":{"application\/json":{"label":"Totam rerum.","purposeKey":"Sit.","statusKey":"Voluptatem.","position":8,"type":"europallet","fullLabel":"Totam rerum.","warehouseLocationLevel":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 storage location","format":"integer","in":"path"}]},"put":{"summary":"Update a storage location","description":"Updates a storage location","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/WarehouseLocation"},"examples":{"application\/json":{"label":"Veritatis voluptas.","purposeKey":"Id.","statusKey":"Omnis.","position":6,"type":"medium","fullLabel":"Veritatis voluptas.","warehouseLocationLevel":null}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 storage location","format":"integer","in":"path"}]}},"\/rest\/warehouses\/structure\/{warehouseId}":{"get":{"summary":"Get a storage location structure","description":"Gets a storage 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 storage location structure moving","description":"Gets a storage 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\/{id}":{"delete":{"summary":"Delete a warehouse","description":"Deletes a warehouse. The ID of the warehouse must be specified.","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/DeleteResponse"},"examples":{"application\/json":{"affectedRows":1}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 warehouse","format":"integer","in":"path"},{"name":"newWarehouseId","type":"integer","required":false,"description":"The ID of the warehouse to which the orders should be transferred","format":"integer","in":"query"}]},"put":{"summary":"Update an existing warehouse","description":"Updates an existing warehouse. The ID of the warehouse must be specified.","tags":["Warehouse"],"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":"id","type":"integer","required":true,"description":"The ID of the warehouse","format":"integer","in":"path"}]}},"\/rest\/warehouses\/{warehouseId}\/locations":{"get":{"summary":"List storage locations","description":"Lists all storage locations for the specified warehouse.","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"}}}},"examples":{"application\/json":{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"label":"Soluta quia.","purposeKey":"Velit itaque.","statusKey":"Hic.","position":2,"type":"large","fullLabel":"Soluta quia.","warehouseLocationLevel":null},{"label":"Maiores.","purposeKey":"Aut voluptate.","statusKey":"Molestias.","position":2,"type":"large","fullLabel":"Maiores.","warehouseLocationLevel":null}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 storage location dimensions","description":"Lists all storage location dimensions.","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/WarehouseLocationDimension"},"examples":{"application\/json":{"parentId":1,"warehouseId":354860851,"level":33,"name":"Sint eius consequatur voluptas delectus rem.","displayInName":false,"shortcut":"Amet eum distinctio.","separator":"_","isActiveForPickupPath":true}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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 storage locations by levelId","description":"Lists all storage 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 storage 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 storage location levels","description":"Lists all storage location levels.","tags":["Warehouse"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#\/definitions\/WarehouseLocationLevel"}},"examples":{"application\/json":[{"parentId":4,"position":3,"pickupPathPosition":5,"pathName":"Corrupti.","name":"Perspiciatis ut quisquam sit amet."},{"parentId":4,"position":0,"pickupPathPosition":4,"pathName":"Est sunt.","name":"Doloremque expedita saepe dolorum ut."}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/warranties":{"post":{"summary":"Create a warranty","description":"Creates a warranty.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":9,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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\/warranties\/items\/{orderItemId}\/assign_variation":{"post":{"summary":"Change an order item of type \"unassigned variation\" to \"variation\".","description":"Change an order item of type \"unassigned variation\" to \"variation\". The ID of the order item and variation ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":7,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/warranties\/items\/{orderItemId}\/unassign_variation":{"post":{"summary":"Change an order item of type \"variation\" to \"unassigned variation\".","description":"Change an order item of type \"variation\" to \"unassigned variation\". The ID of the order item must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":1,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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"}]}},"\/rest\/warranties\/preview":{"post":{"summary":"Get a warranty create preview.","description":"Returns a warranty preview for the given order data without creating a warranty.","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\/warranties\/{orderId}":{"delete":{"summary":"Delete a warranty","description":"Deletes a warranty. 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 warranty","description":"Updates a warranty. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":9,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/warranties\/{orderId}\/book":{"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","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"},{"in":"body","name":"\/rest\/warranties\/{orderId}\/book","schema":{"type":"object","properties":{"message":{"type":"string","description":""},"bookingDate":{"type":"string","description":""}}}}]}},"\/rest\/warranties\/{orderId}\/cancel_booking":{"post":{"summary":"Revert outgoing stock","description":"Cancellation the booking of an order. The ID of the order must be specified. With the array 'quantities' the items to cancel can be defined. If 'quantities' is not given, the whole order will be cancelled and the booking date will be deleted. If 'quantities' is defined, the booking date won't be reset.","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"},{"in":"body","name":"\/rest\/warranties\/{orderId}\/cancel_booking","schema":{"type":"object","properties":{"changeStatus":{"type":"boolean","description":""},"quantities":{"type":"array","items":{}}}}}]}},"\/rest\/warranties\/{orderId}\/cancel_booking\/validate":{"post":{"summary":"Validate cancellation of the booking of an order","description":"Validates cancellation of the booking 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\/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":"","format":"integer","in":"path"}]}},"\/rest\/warranties\/{orderId}\/preview":{"put":{"summary":"Get a warranty update preview","description":"Returns a warranty preview for the given order data without updating a warranty. The order ID 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":"orderId","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/warranties\/{orderId}\/restore":{"post":{"summary":"Restore a warranty","description":"Restores a deleted warranty. The order ID must be specified.","tags":["Order"],"security":[{"oAuth2":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#\/definitions\/Order"},"examples":{"application\/json":{"statusName":"","plentyId":65411,"typeId":1,"lockStatus":"unlocked","locationId":null,"createdAt":null,"updatedAt":null,"statusId":null,"ownerId":null,"relations":[],"properties":[{"orderId":null,"typeId":4,"value":"unpaid"}],"dates":[{"orderId":null,"typeId":2,"date":null},{"orderId":null,"typeId":4,"date":null}]}}},"401":{"description":"The resource owner or authorization server denied the request. - The request is missing a 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\/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"}},"examples":{"application\/json":[{"id":2798445,"name":"PtremblayShop","storeIdentifier":15214,"pluginSetId":43,"configuration":{"defaultCurrencyList":[]}},{"id":2344927,"name":"Velma.luettgenShop","storeIdentifier":14694,"pluginSetId":44,"configuration":{"defaultCurrencyList":[]}}]}},"401":{"description":"The resource owner or authorization server denied the request. - The request is 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":{"get":{"summary":"List wizards","description":"Lists all wizards.","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\/pluginSets":{"get":{"summary":"Get non cached sets","description":"Gets all non cached sets.","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."}}}},"\/rest\/wizards\/{wizardKey}":{"get":{"summary":"Get a wizard","description":"Gets a specific wizard by wizard key.","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 wizard data for a specific wizard.","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":"Loads dynamic data 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":"formfieldKey","type":"integer","required":true,"description":"","format":"integer","in":"path"}]}},"\/rest\/wizards\/{wizardKey}\/rebuildCache":{"get":{"summary":"Rebuild wizard cache","description":"Rebuilds cache of a given wizardKey and retuns the new cached data","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"}]}},"\/rest\/wizards\/{wizardKey}\/settings\/{optionId}":{"post":{"summary":"Finalize the wizard.","description":"Finalizes a wizard by key.","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 My account area."},"password":{"type":"string","description":"The password associated with the My account area."}}}}]}},"\/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<ul>\n<li>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<li>payment = The debtor accounts are selected based on the payment method.<\/li>\n<li>country = The debtor accounts are selected based on the country of delivery.<\/li>\n<li>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<ul>\n<li>FNV = stands for the sequence: company, lastname, firstname<\/li>\n<li>NVF = stands for the sequence: lastname, firstname, company<\/li>\n<li>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?"},"isReverseCharge":{"type":"boolean","description":"Is the reverse charge method activated?"}}},"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"},"externalId":{"type":"string","description":"The externalId for this company (like the hubspot company id)"},"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, <i>read only<\/i>)"},"firstName":{"type":"string","description":"The first name (alias for name2, <i>read only<\/i>)"},"lastName":{"type":"string","description":"The last name (alias for name3, <i>read only<\/i>)"},"careOf":{"type":"string","description":"The c\/o (alias for name4, <i>read only<\/i>)"},"street":{"type":"string","description":"The street (alias for address1, <i>read only<\/i>)"},"houseNumber":{"type":"string","description":"The house number (alias for address2, <i>read only<\/i>)"},"additional":{"type":"string","description":"The additional address information (alias for address3, <i>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, <i>read only<\/i>)"},"externalId":{"type":"string","description":"The externalId option (alias for option with typeId 2, <i>read only<\/i>)"},"entryCertificate":{"type":"boolean","description":"The entryCertificate option (alias for option with typeId 3, <i>read only<\/i>)"},"phone":{"type":"string","description":"The phone option (alias for option with typeId 4, <i>read only<\/i>)"},"email":{"type":"string","description":"The email option (alias for option with typeId 5, <i>read only<\/i>)"},"postident":{"type":"string","description":"The PostIdent option (alias for option with typeId 6, <i>read only<\/i>)"},"personalNumber":{"type":"string","description":"The personal number option (alias for option with typeId 7, <i>read only<\/i>)"},"fsk":{"type":"string","description":"The age rating option (alias for option with typeId 8, <i>read only<\/i>)"},"birthday":{"type":"string","description":"The birthday option (alias for option with typeId 9, <i>read only<\/i>)"},"title":{"type":"string","description":"The title option (alias for option with typeId 11, <i>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, <i>read only<\/i>)"},"contactPerson":{"type":"string","description":"The contact person option (alias for option with typeId 12, <i>read only<\/i>)"},"externalCustomerId":{"type":"string","description":"The external customer ID option (alias for option with typeId 13, <i>read only<\/i>)"},"packstationNo":{"type":"string","description":"The packstation number (alias for houseNumber and address2, <i>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<ul>\n<li>Invoice address = 1<\/li>\n<li>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<ul>\n<li>1 = VAT number<\/li>\n<li>2 = External address ID<\/li>\n<li>3 = Entry certificate<\/li>\n<li>4 = Telephone<\/li>\n<li>5 = Email<\/li>\n<li>6 = Post number<\/li>\n<li>7 = Personal id<\/li>\n<li>8 = BBFC (age rating)<\/li>\n<li>9 = Birthday<\/li>\n<li>10 = Session ID<\/li>\n<li>11 = Title<\/li>\n<li>12 = Contact person<\/li>\n<li>13 = External customer ID<\/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<ul>\n<li>1 = Billing address<\/li>\n<li>2 = Delivery address<\/li>\n<li>3 = Sender address<\/li>\n<li>4 = Return address<\/li>\n<li>5 = Client address<\/li>\n<li>6 = Contractor address<\/li>\n<li>7 = Warehouse address<\/li>\n<li>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"},"isPrimary":{"type":"integer","description":""}}},"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<ul>\n<li> 0 = not blocked<\/li>\n<li> 1 = blocked<\/li>\n<\/ul>"},"rating":{"type":"integer","description":"The rating of the contact. This rating is for internal use only.\n5 red stars are for the worst and 5 yellow stars for the best rating. Possible values:\n<ul>\n<li>-5 = 5 red stars (worst rating)<\/li>\n<li>-4 = 4 red stars<\/li>\n<li>-3 = 3 red stars<\/li>\n<li>-2 = 2 red stars<\/li>\n<li>-1 = 1 red star<\/li>\n<li>0 = 5 grey stars, no rating saved for the contact<\/li>\n<li>1 = 1 yellow star<\/li>\n<li>2 = 2 yellow stars<\/li>\n<li>3 = 3 yellow stars<\/li>\n<li>4 = 4 yellow stars<\/li>\n<li>5 = 5 yellow stars (best rating)<\/li>\n<\/ul>"},"bookAccount":{"type":"string","description":"The book account (debtor account) of the contact.\nAn additional, separate number that generally corresponds to the customer number or\nthe debtor number in your financial accounting."},"lang":{"type":"string","description":"The language of the contact"},"referrerId":{"type":"number","description":"The origin of the contact"},"plentyId":{"type":"integer","description":"The client (store) that is assigned to the contact"},"userId":{"type":"integer","description":"The owner ID of the contact"},"birthdayAt":{"type":"string","description":"The date of birth of the contact"},"lastLoginAt":{"type":"string","description":"The date of the last login of the contact"},"lastLoginAtTimestamp":{"type":"string","description":"The date of the last login of the contact"},"lastOrderAt":{"type":"string","description":"The date of the last order"},"createdAt":{"type":"string","description":"The date the contact was created"},"updatedAt":{"type":"string","description":"The date the contact was last updated"},"privatePhone":{"type":"string","description":"The private phone number of the contact"},"privateFax":{"type":"string","description":"The private fax number of the contact"},"privateMobile":{"type":"string","description":"The private mobile phone number of the contact"},"ebayName":{"type":"string","description":"The eBay account name of the contact"},"paypalEmail":{"type":"string","description":"The email address of the PayPal account of the contact"},"paypalPayerId":{"type":"string","description":"The PayPal payer id of the contact"},"klarnaPersonalId":{"type":"string","description":"The Klarna personal id of the contact"},"dhlPostIdent":{"type":"string","description":"The DHL PostIdent of the contact"},"forumUsername":{"type":"string","description":"The user name of the contact in the forum"},"forumGroupId":{"type":"string","description":"The ID of the forum group that is assigned to the contact"},"singleAccess":{"type":"string","description":"The access type of the contact"},"contactPerson":{"type":"string","description":"The contact person of the contact"},"marketplacePartner":{"type":"string","description":"The marketplace partner status of the contact"},"valuta":{"type":"integer","description":"The foreign currency of the contact"},"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 salesRepresentative ID of the contact"},"anonymizeAt":{"type":"string","description":"The date at which the contact will be anonymized."},"isLead":{"type":"boolean","description":"Defines if contact is a lead."},"leadStatusKey":{"type":"string","description":"The current lead status key"},"inLeadStatusSince":{"type":"integer","description":"The number of days since the current lead status has been set"},"leadStatusUpdateAt":{"type":"string","description":"DEPRECATED - See leadStatusUpdatedAt"},"position_id":{"type":"integer","description":"The job position ID of the contact"}}},"ContactBank":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the bank account"},"contactId":{"type":"integer","description":"The ID of the contact the bank account belongs to"},"orderId":{"type":"integer","description":"The ID of the order the bank account belongs to"},"accountOwner":{"type":"string","description":"The owner of the bank account"},"bankName":{"type":"string","description":"The name of the bank"},"bankAddress":{"type":"string","description":"The address of the bank"},"bankPostalCodeTown":{"type":"string","description":"The postcode and town of the bank"},"bankCountry":{"type":"string","description":"The country of the bank"},"iban":{"type":"string","description":"The IBAN of the bank account"},"bic":{"type":"string","description":"The BIC of the bank account"},"accountNumber":{"type":"string","description":"The account number of the bank account"},"sortCode":{"type":"string","description":"The sort code of the bank account"},"lastUpdateBy":{"type":"string","description":"The source of the last change (possible values: `customer`, `backend`, `import`)"},"directDebitMandateAvailable":{"type":"integer","description":"Flag that indicates if a direct debit mandate is available"},"directDebitMandateAt":{"type":"string","description":"The time the direct debit mandate was created as unix timestamp"},"directDebitMethod":{"type":"string","description":"The direct debit method (possible values: `sepaDirectDebit`, `sepaB2bDirectDebit`)"},"directDebitType":{"type":"string","description":"The direct debit type (possible values: `first`, `next`)"},"paymentMethod":{"type":"string","description":"The payment method (possible values: `recurrent`, `onOff`)"},"createdAt":{"type":"string","description":"The time the bank account was created as unix timestamp"},"updatedAt":{"type":"string","description":"The time the bank account was last updated as unix timestamp"}}},"bool":{"type":"object","properties":{}},"string":{"type":"object","properties":{}},"ContactClass":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the contact class"},"name":{"type":"string","description":""},"priceColumn":{"type":"integer","description":""},"showPrice":{"type":"integer","description":"Flag to display price in the online store as Gross(1) or Net(2)"},"discountType":{"type":"integer","description":""},"position":{"type":"integer","description":""},"pqsQuantity1":{"type":"number","description":""},"":{"type":"number","description":"pqsDiscount10"},"pqsQuantity2":{"type":"number","description":""},"pqsQuantity3":{"type":"number","description":""},"pqsQuantity4":{"type":"number","description":""},"pqsQuantity5":{"type":"number","description":""},"pqsQuantity6":{"type":"number","description":""},"pqsQuantity7":{"type":"number","description":""},"pqsQuantity8":{"type":"number","description":""},"pqsQuantity9":{"type":"number","description":""},"pqsQuantity10":{"type":"number","description":""},"pnsQuantity1":{"type":"number","description":""},"pnsDiscount1":{"type":"number","description":""},"pnsQuantity2":{"type":"number","description":""},"pnsDiscount2":{"type":"number","description":""},"pnsQuantity3":{"type":"number","description":""},"pnsDiscount3":{"type":"number","description":""},"pnsQuantity4":{"type":"number","description":""},"pnsDiscount4":{"type":"number","description":""},"pnsQuantity5":{"type":"number","description":""},"pnsDiscount5":{"type":"number","description":""},"pmsMop":{"type":"string","description":""},"pmsDiscount":{"type":"number","description":""},"paqsDiscount":{"type":"number","description":""},"payableDueWithin":{"type":"integer","description":""},"minQuantity":{"type":"integer","description":""},"dontUseItemPriceRebates":{"type":"integer","description":""},"customerId":{"type":"integer","description":""},"allowedMops":{"type":"string","description":"The list of allowed payment methods"},"pdwQuantity1":{"type":"number","description":""},"pdwDays1":{"type":"integer","description":""},"pdwQuantity2":{"type":"number","description":""},"pdwDays2":{"type":"integer","description":""},"pdwQuantity3":{"type":"number","description":""},"pdwDays3":{"type":"integer","description":""},"pdwQuantity4":{"type":"number","description":""},"pdwDays4":{"type":"integer","description":""},"pdwQuantity5":{"type":"number","description":""},"pdwDays5":{"type":"integer","description":""},"customerGroupsPaymentNotice":{"type":"string","description":""},"earlyPaymentDiscount":{"type":"number","description":""},"earlyPaymentDiscountDays":{"type":"number","description":""},"valuta":{"type":"integer","description":""},"manualDiscount":{"type":"number","description":""},"allowedMethodOfPaymentIdsList":{"type":"array","items":{},"description":""}}},"ContactEvent":{"type":"object","properties":{"eventId":{"type":"integer","description":"The ID of the event"},"contactId":{"type":"integer","description":"The ID of the contact this event belongs to"},"userId":{"type":"integer","description":"The ID of the user this event belongs to"},"eventDuration":{"type":"integer","description":"The duration of the event in seconds"},"eventType":{"type":"string","description":"The type of the event. Possible values are call, ticket, email, meeting, webinar, development and design."},"orderRowId":{"type":"integer","description":""},"eventInfo":{"type":"string","description":"Informational text about the event"},"billable":{"type":"boolean","description":"Billable if set to 1"},"eventInsertedAt":{"type":"string","description":"The date the event was created at as unix timestamp"},"eventBilledAt":{"type":"string","description":"The date the event was billed at as unix timestamp"},"eventProvisionPaidAt":{"type":"string","description":"The date the provision was paid at as unix timestamp"},"eventCreditValue":{"type":"number","description":"The credit value of the event"}}},"ContactDepartment":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the contact department. It is possible to define individual departments. The following departments are available by default.\n<ul>\n<li>1 = Management<\/li>\n<li>2 = Purchasing Department<\/li>\n<li>3 = Sales Department<\/li>\n<li>4 = Research & Development Team<\/li>\n<li>5 = Production<\/li>\n<li>6 = Quality Assurance<\/li>\n<li>7 = Public Relations<\/li>\n<li>8 = Marketing Department<\/li>\n<li>9 = IT Department<\/li>\n<li>10 = EDP Team<\/li>\n<li>11 = Logistics<\/li>\n<li>12 = Warehousing Department<\/li>\n<li>13 = Export Department<\/li>\n<li>14 = Import Department<\/li>\n<li>15 = Customer Service<\/li>\n<li>16 = Technical Support Team<\/li>\n<li>17 = Human Resources<\/li>\n<li>18 = Accounting Department<\/li>\n<li>19 = Financial Department<\/li>\n<li>20 = Legal Department<\/li>\n<li>21 = Secretary's Office<\/li>\n<\/ul>"},"position":{"type":"integer","description":"The position for sorting"}}},"ContactDepartmentName":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the contact department name"},"departmentId":{"type":"integer","description":"The ID of the department"},"lang":{"type":"string","description":"The language"},"name":{"type":"string","description":"The name"}}},"SimpleRestResponse":{"type":"object","properties":{}},"ContactOptionSubType":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the contact option sub-type. It is possible to define individual option sub-types. The following types are available by default and cannot be deleted.\n<ul>\n<li>1 = Work<\/li>\n<li>2 = Mobile private<\/li>\n<li>3 = Mobile work<\/li>\n<li>4 = Private<\/li>\n<li>5 = PayPal<\/li>\n<li>6 = Ebay<\/li>\n<li>7 = Amazon<\/li>\n<li>8 = Klarna<\/li>\n<li>9 = DHL<\/li>\n<li>10 = Forum<\/li>\n<li>11 = Guest<\/li>\n<li>12 = Contact person<\/li>\n<li>13 = Marketplace partner<\/li>\n<li>15 = User<\/li>\n<\/ul>"},"position":{"type":"integer","description":"The position for sorting"},"nonErasable":{"type":"integer","description":"Flag that indicates if the option sub-type can be deleted"}}},"ContactOptionType":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the contact option type. It is possible to define individual option types. The following types are available by default and cannot be deleted.\n<ul>\n<li>1 = Telephone<\/li>\n<li>2 = Email<\/li>\n<li>3 = Telefax<\/li>\n<li>4 = Web page<\/li>\n<li>5 = Marketplace<\/li>\n<li>6 = Identification number<\/li>\n<li>7 = Payment<\/li>\n<li>8 = User name<\/li>\n<li>9 = Group<\/li>\n<li>10 = Access<\/li>\n<li>11 = Additional<\/li>\n<li>13 = Converted by<\/li>\n<\/ul>"},"position":{"type":"integer","description":"The position for sorting"},"nonErasable":{"type":"integer","description":"Flag that indicates if the option type can be deleted"}}},"ContactOption":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the contact option"},"contactId":{"type":"integer","description":"The ID of the contact the option belongs to"},"typeId":{"type":"integer","description":"The type ID of the contact option.\nIt is possible to define individual contact option types.\nThe following types are available by default and cannot be deleted:\n<ul>\n<li>1 = Telephone<\/li>\n<li>2 = Email<\/li>\n<li>3 = Telefax<\/li>\n<li>4 = Web page<\/li>\n<li>5 = Marketplace<\/li>\n<li>6 = Identification number<\/li>\n<li>7 = Payment<\/li>\n<li>8 = User name<\/li>\n<li>9 = Group<\/li>\n<li>10 = Access<\/li>\n<li>11 = Additional<\/li>\n<li>13 = Converted by<\/li>\n<\/ul>"},"subTypeId":{"type":"integer","description":"The sub-type ID of the contact option.\nIt is possible to define individual contact option sub-types.\nThe following types are available by default and cannot be deleted:\n<ul>\n<li>1 = Work<\/li>\n<li>2 = Mobile private<\/li>\n<li>3 = Mobile work<\/li>\n<li>4 = Private<\/li>\n<li>5 = PayPal<\/li>\n<li>6 = Ebay<\/li>\n<li>7 = Amazon<\/li>\n<li>8 = Klarna<\/li>\n<li>9 = DHL<\/li>\n<li>10 = Forum<\/li>\n<li>11 = Guest<\/li>\n<li>12 = Contact person<\/li>\n<li>13 = Marketplace partner<\/li>\n<li>15 = User<\/li>\n<\/ul>"},"value":{"type":"string","description":"The value of the option. Depends on the type\/sub-type."},"priority":{"type":"integer","description":"The priority 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"}}},"ContactPosition":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the contact position. It is possible to define individual contact positions. The following positions are available by default:\n<ul>\n<li>1 = Analyst<\/li>\n<li>2 = Director of Boards<\/li>\n<li>3 = CEO<\/li>\n<li>4 = Buyer<\/li>\n<li>5 = Purchasing Manager<\/li>\n<li>6 = CFO<\/li>\n<li>7 = Director General<\/li>\n<li>8 = Managing Director<\/li>\n<li>9 = Codirector<\/li>\n<li>10 = Commercial Agent<\/li>\n<li>11 = Assistant<\/li>\n<li>12 = Service Engineer<\/li>\n<li>13 = Warehouse Manager<\/li>\n<li>14 = Warehouse Worker<\/li>\n<li>15 = Senior Executive<\/li>\n<li>16 = Assistent<\/li>\n<li>17 = Purchasing Assistent<\/li>\n<li>18 = Software Developer<\/li>\n<li>19 = Sales Representative<\/li>\n<li>20 = Sales Manager<\/li>\n<li>21 = Export Sales Manager<\/li>\n<li>22 = Wholesale Distributing Manager<\/li>\n<li>23 = Secretary<\/li>\n<li>24 = Economist<\/li>\n<li>25 = Management Board<\/li>\n<\/ul>"},"position":{"type":"integer","description":"The position for sorting"}}},"ContactPositionName":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the contact position name"},"positionId":{"type":"integer","description":"The ID of the position"},"lang":{"type":"string","description":"The language"},"name":{"type":"string","description":"The name"}}},"ContactType":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the contact type. It is possible to define individual contact types. The following types are available by default and cannot be deleted.\n<ul>\n<li>1 = Customer<\/li>\n<li>2 = Sales lead\/Interested party<\/li>\n<li>3 = Sales representative<\/li>\n<li>4 = Supplier<\/li>\n<li>5 = Producer\/Manufacturer<\/li>\n<li>6 = Partner<\/li>\n<\/ul>"},"position":{"type":"integer","description":"The position for sorting"},"nonErasable":{"type":"integer","description":"Flag that indicates if the type can be deleted"}}},"StorageObject":{"type":"object","properties":{"key":{"type":"string","description":""},"path":{"type":"string","description":""},"lastModified":{"type":"string","description":""},"metaData":{"type":"array","items":{},"description":""},"eTag":{"type":"string","description":""},"size":{"type":"integer","description":""},"storageClass":{"type":"string","description":""},"body":{"type":"string","description":""},"contentType":{"type":"string","description":""},"contentLength":{"type":"string","description":""}}},"StorageObjectList":{"type":"object","properties":{"isTruncated":{"type":"boolean","description":""},"nextContinuationToken":{"type":"string","description":""},"commonPrefixes":{"type":"array","items":{},"description":""}}},"Job":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the job"},"position":{"type":"integer","description":"The position ID"},"createdAt":{"type":"string","description":"The date the contact was created"},"updatedAt":{"type":"string","description":"The date the contact was last updated"}}},"OrderSummary":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the order summary"},"addressId":{"type":"integer","description":"The address ID of the order summary"},"contactId":{"type":"integer","description":"The ID of the contact"},"unpaidOrdersCount":{"type":"integer","description":"The number of unpaid orders"},"unpaidOrderTotalAmount":{"type":"number","description":"The total amount of unpaid orders"},"orderCount":{"type":"integer","description":"The number of all orders of the associated model"},"createdAt":{"type":"string","description":"The time the order summary was created as unix timestamp"},"updatedAt":{"type":"string","description":"The time the order summary was last updated as unix timestamp"}}},"SimpleJsonResponse":{"type":"object","properties":{}},"SalesRepresentativeRegion":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the account contact sales representative relation"},"accountContactRelationId":{"type":"integer","description":"The ID of the foreign key account contact relation"},"postalCodeArea":{"type":"string","description":""},"countryId":{"type":"integer","description":""}}},"AddressLayout":{"type":"object","properties":{"isDefault":{"type":"boolean","description":""},"uuid":{"type":"string","description":""},"countries":{"type":"array","items":{},"description":"Class AddressLayout"}}},"Order":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the order"},"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"},"statusId":{"type":"number","description":"The ID of the order status"},"statusName":{"type":"string","description":"The name for the status ID (read only)"},"ownerId":{"type":"integer","description":"The user ID of the order's owner"},"referrerId":{"type":"number","description":"The referrer ID of the order"},"createdAt":{"type":"string","description":"The date that the order was created"},"updatedAt":{"type":"string","description":"The date that the order was updated last"},"plentyId":{"type":"integer","description":"The plenty ID of the client that the order belongs to"},"locationId":{"type":"integer","description":"The ID of the location that the order belongs to"},"roundTotalsOnly":{"type":"boolean","description":"True means only the order's total amounts are rounded, false the order item price is rounded too. (read-only)"},"numberOfDecimals":{"type":"integer","description":"The number of decimals this order was rounded with. (read-only)"},"lockStatus":{"type":"string","description":"The lock status of the order. The following statuses are available:\n\n* unlocked\n* permanentlyLocked\n* reversibleLocked"},"isLocked":{"type":"boolean","description":"True, if the order has the lock status \"unlocked\". False otherwise."},"hasTaxRelevantDocuments":{"type":"boolean","description":""},"hasDeliveryOrders":{"type":"boolean","description":"Has the order delivery orders?"},"legacyOrderType":{"type":"string","description":"The legacy order type as string"},"contactSenderId":{"type":"integer","description":""},"contactReceiverId":{"type":"integer","description":""},"warehouseSenderId":{"type":"integer","description":""},"warehouseReceiverId":{"type":"integer","description":""}}},"Archive":{"type":"object","properties":{"file":{"type":"string","description":"The file name of the archive"},"month":{"type":"integer","description":"The month of the archive"},"year":{"type":"integer","description":"The year of the archive"},"size":{"type":"integer","description":"The size of the archive"},"status":{"type":"string","description":"The status of the file. Possible values are: accessible, restore_in_progress, archived"}}},"Response":{"type":"object","properties":{}},"EntityGroup":{"type":"object","properties":{"name":{"type":"string","description":"The group name"}}},"SystemConfig":{"type":"object","properties":{"archiveActive":{"type":"boolean","description":"Is the Archive activated"}}},"JsonResponse":{"type":"object","properties":{}},"Availability":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of this availability"},"icon":{"type":"string","description":"The icon of this availability"},"averageDays":{"type":"integer","description":"The average delivery time in days for this availability"}}},"AvailabilityName":{"type":"object","properties":{"availabilityId":{"type":"integer","description":"The ID of the availability that the name belongs to"},"lang":{"type":"string","description":"The <a href=\"https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#languages\" target=\"_blank\">language code<\/a> of the availability name"},"name":{"type":"string","description":"The name of the item availability in the specified language"}}},"User":{"type":"object","properties":{"id":{"type":"integer","description":""},"user":{"type":"string","description":""},"realName":{"type":"string","description":""},"lang":{"type":"string","description":""},"ipLimit":{"type":"string","description":""},"ustatus":{"type":"boolean","description":""},"memberId":{"type":"integer","description":""},"timestamp":{"type":"string","description":""},"email":{"type":"string","description":""},"timezone":{"type":"string","description":""},"googleEmail":{"type":"string","description":""},"skype":{"type":"string","description":""},"ical":{"type":"string","description":""},"psConfig":{"type":"boolean","description":""},"psItem":{"type":"boolean","description":""},"psEbay":{"type":"boolean","description":""},"psStock":{"type":"boolean","description":""},"psCustomer":{"type":"boolean","description":""},"psOrder":{"type":"boolean","description":""},"psStats":{"type":"boolean","description":""},"psData":{"type":"boolean","description":""},"pcConfig":{"type":"boolean","description":""},"pcContent":{"type":"boolean","description":""},"pcNewsletter":{"type":"boolean","description":""},"pcLayout":{"type":"boolean","description":""},"pcDialog":{"type":"boolean","description":""},"pcStats":{"type":"boolean","description":""},"pcData":{"type":"boolean","description":""},"pcBlog":{"type":"boolean","description":""},"signature":{"type":"string","description":""},"color":{"type":"string","description":""},"eks":{"type":"boolean","description":""},"payments":{"type":"boolean","description":""},"acceptAgb":{"type":"integer","description":""},"api":{"type":"boolean","description":""},"image":{"type":"string","description":""},"delOrder":{"type":"boolean","description":""},"delArticle":{"type":"boolean","description":""},"delRecord":{"type":"boolean","description":""},"plentystat":{"type":"boolean","description":""},"plentyconnect":{"type":"boolean","description":""},"webspaceAccess":{"type":"boolean","description":""},"accessControlList":{"type":"string","description":""},"plentymarketsShippingOrderId":{"type":"boolean","description":""},"plentymarketsShippingItem":{"type":"boolean","description":""},"plentymarketsShippingAuto":{"type":"boolean","description":""},"plentymarketsShippingLabel":{"type":"boolean","description":""},"plentymarketsShippingConfig":{"type":"boolean","description":""},"warehouseId":{"type":"integer","description":""},"calendar":{"type":"boolean","description":""},"orderStatus":{"type":"string","description":""},"warehouseRepairId":{"type":"integer","description":""},"project":{"type":"boolean","description":""},"ticket":{"type":"boolean","description":""},"order":{"type":"boolean","description":""},"blog":{"type":"boolean","description":""},"lead":{"type":"boolean","description":""},"customer":{"type":"boolean","description":""},"totalVacationDays":{"type":"number","description":""},"roleId":{"type":"integer","description":""},"salutation":{"type":"string","description":""},"dataLang":{"type":"string","description":""},"disabled":{"type":"boolean","description":""},"scheduler":{"type":"boolean","description":""},"item":{"type":"boolean","description":""},"incomingItems":{"type":"boolean","description":""},"backendPluginSetId":{"type":"integer","description":"The ID of the user's selected backend set"}}},"Basket":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the shopping cart. The ID increases by 1 when a new customer enters the online store and adds an item to the shopping cart."},"sessionId":{"type":"string","description":"The ID of the current customer session"},"orderId":{"type":"integer","description":"The ID of the order"},"customerId":{"type":"integer","description":"The ID of the customer"},"customerInvoiceAddressId":{"type":"integer","description":"The ID of the customer's invoice address"},"customerShippingAddressId":{"type":"integer","description":"The ID of the customer's shipping address"},"currency":{"type":"string","description":"The currency"},"referrerId":{"type":"number","description":"The ID of the order referrer"},"shippingCountryId":{"type":"integer","description":"The ID of the shipping country"},"methodOfPaymentId":{"type":"integer","description":"The ID of the payment method"},"shippingProviderId":{"type":"integer","description":"The ID of the shipping provider"},"shippingProfileId":{"type":"integer","description":"The ID of the shipping profile"},"itemSum":{"type":"number","description":"The gross value of items in the shopping cart"},"itemSumNet":{"type":"number","description":"The net value of items in the shopping cart"},"basketAmount":{"type":"number","description":"The total gross value of the shopping cart"},"basketAmountNet":{"type":"number","description":"The total net value of the shopping cart"},"shippingAmount":{"type":"number","description":"The gross shipping costs"},"shippingAmountNet":{"type":"number","description":"The net shipping costs"},"paymentAmount":{"type":"number","description":"The amount of the payment"},"couponCode":{"type":"string","description":"The entered coupon code"},"couponDiscount":{"type":"number","description":"The received discount due to the coupon code"},"shippingDeleteByCoupon":{"type":"boolean","description":"Shows whether the shipping costs are subtracted due to a coupon code. Shopping carts that are free of shipping costs have the value true."},"basketRebate":{"type":"number","description":"The discount to the shopping cart value. The discount can either be set as a discount scale for items, as a customer class discount or as a discount based on the payment method."},"basketRebateType":{"type":"integer","description":"The discount type. The following types are available:\n<ul>\n <li>Discount scale based on net value of items = 4<\/li>\n <li> Discount based on method of payment = 5<\/li>\n<\/ul>"},"maxFsk":{"type":"integer","description":"The age rating"},"orderTimestamp":{"type":"integer","description":"The timestamp of the order"},"createdAt":{"type":"string","description":"The date that the shopping cart was created."},"updatedAt":{"type":"string","description":"The date that the shopping cart was updated last."}}},"BasketItem":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the item in the shopping cart"},"basketId":{"type":"integer","description":"The ID of the shopping cart. The ID increases by 1 when a new customer enters the online store and adds an item to the shopping cart."},"sessionId":{"type":"string","description":"The ID of the current customer session"},"orderRowId":{"type":"integer","description":""},"quantity":{"type":"number","description":"The current quantity of the item"},"quantityOriginally":{"type":"number","description":"The initial quantity of the item"},"itemId":{"type":"integer","description":"The ID of the item"},"priceId":{"type":"integer","description":"The ID of the item price"},"attributeValueSetId":{"type":"integer","description":"The ID of the attribute value set"},"rebate":{"type":"integer","description":"The discount on the item"},"vat":{"type":"number","description":"The VAT"},"price":{"type":"number","description":"The item price"},"givenPrice":{"type":"number","description":"The given item price"},"givenVatId":{"type":"integer","description":"The given vat id."},"useGivenPrice":{"type":"boolean","description":"The flag to use the given values"},"inputWidth":{"type":"integer","description":"The width of the item"},"inputLength":{"type":"integer","description":"The length of the item"},"inputHeight":{"type":"integer","description":"The height of the item"},"itemType":{"type":"integer","description":"The item type"},"externalItemId":{"type":"string","description":"The external variation ID"},"noEditByCustomer":{"type":"boolean","description":"Shows whether the item was edited by the customer"},"costCenterId":{"type":"integer","description":""},"giftPackageForRowId":{"type":"integer","description":""},"position":{"type":"integer","description":"The item position"},"size":{"type":"string","description":"The item size"},"shippingProfileId":{"type":"integer","description":"The ID of the shipping profile"},"referrerId":{"type":"number","description":"The ID of the order referrer"},"deliveryDate":{"type":"string","description":"The delivery date"},"categoryId":{"type":"integer","description":"The ID of the item category"},"reservationDatetime":{"type":"integer","description":""},"variationId":{"type":"integer","description":"The ID of the item variation"},"bundleVariationId":{"type":"integer","description":"The ID of the item bundle type"},"createdAt":{"type":"string","description":"The date that the shopping cart was created"},"updatedAt":{"type":"string","description":"The date that the shopping cart was updated last"},"attributeTotalMarkup":{"type":"number","description":"attribute total markup"},"basketItemOrderParams":{"type":"array","items":{},"description":"Array of BasketItemParams"},"basketItemVariationProperties":{"type":"array","items":{},"description":"Array of BasketItemVariationProperties"}}},"KeyFigureConfig":{"type":"object","properties":{"id":{"type":"string","description":"Id of this configuration"},"hash":{"type":"string","description":"Hash value to check for updates and avoid duplicate key figures with the same filters"},"plentyId":{"type":"integer","description":"The plentymarkets system id"},"plentyIdHash":{"type":"string","description":"The plentymarkets system id hash"},"keyFigure":{"type":"string","description":"Key figure identifier"},"keyFigureCaption":{"type":"string","description":"Key figure caption"},"keyFigureName":{"type":"string","description":"User defined name"},"direct":{"type":"boolean","description":"This key figure triggers a direct calculation without saving the result"},"freeOfCharge":{"type":"boolean","description":"Is this key figure free of charge"},"isGlobal":{"type":"boolean","description":""},"updatedAt":{"type":"string","description":"Time of last change"},"createdAt":{"type":"string","description":"Time of creation"},"externalId":{"type":"string","description":"Identifier to assign the model"},"dimensions":{"type":"array","items":{},"description":"List of existing dimensions"},"dimensionValues":{"type":"array","items":{},"description":"List of dimension values"},"category":{"type":"string","description":"The translated category text of the keyfigure"},"aggregateFunctions":{"type":"array","items":{},"description":"List of supported SQL aggregate functions"}}},"KeyFigure":{"type":"object","properties":{"title":{"type":"string","description":""},"description":{"type":"string","description":""},"category":{"type":"string","description":"Key figure category name"},"keyFigure":{"type":"string","description":""},"dataSeries":{"type":"boolean","description":""},"resultFields":{"type":"array","items":{},"description":""},"primaryResultField":{"type":"string","description":""},"rawDataDeleteAble":{"type":"boolean","description":"Raw data should be deleted from the data warehouse"},"freeOfCharge":{"type":"boolean","description":"Is this key figure free of charge"},"rawDataColumns":{"type":"array","items":{},"description":""},"resultExportColumns":{"type":"array","items":{},"description":""},"calculation":{"type":"array","items":{},"description":""},"dimensions":{"type":"array","items":{},"description":""},"dataFilters":{"type":"array","items":{},"description":""},"aggregateFunctions":{"type":"array","items":{},"description":"List of allowed sql aggregate functions. The user can select a value for the display of the calculation results."},"resultUnitsList":{"type":"array","items":{},"description":"List of possible result units. [ ['calculation' => 'exampleCalculation', 'unit' => 'exampleUnit'], [...] ]"}}},"int":{"type":"object","properties":{}},"KeyFigureResultSearchResponse":{"type":"object","properties":{}},"KeyFigureSearchRequest":{"type":"object","properties":{"configId":{"type":"string","description":"Filter that restricts the search result to key figure results of key figure configuration id. The id of the key figure configuration is mandatory and must be specified, if no value is passed for id."},"interval":{"type":"string","description":"Time interval in which the result was calculated: day, week, month, quarter, year."},"dimension":{"type":"string","description":"This field will be removed until 11.2020"},"dimensions":{"type":"array","items":{},"description":"Filter that restricts the search result to key figure results of one data group. The dimension must be specified."},"scaleBasis":{"type":"string","description":"Filter restricts the list of results to items with a scale base time during the specified period. For the time interval day, a date or comma separated two dates (format: YYYYMMDD) can be specified. For the time interval week, several comma-separated days (YYYYMMDD) of different weeks can be specified. For the interval month, a comma separated list of months is expected e.g. 2020-01, 2020-02."},"resultId":{"type":"boolean","description":"Return ID of key figure result"},"resultUnit":{"type":"boolean","description":"Return unit of the primary result."},"target":{"type":"boolean","description":"Return key figure target figure."},"groupByDimension":{"type":"boolean","description":"Groups the results by dimension"},"aggregateDimensions":{"type":"boolean","description":"Returns results for all dimensions"},"aggregateFunction":{"type":"string","description":"Define aggregate (group) function that will operate on key figure results. Default function: sum. Allowed values: sum, avg, count, max, min"},"itemsPerPage":{"type":"integer","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. The default number of results is 12 and the maximum is 100."},"page":{"type":"integer","description":"Number of the requested page, default value: 1"},"searchId":{"type":"string","description":"Identification string to assign the result"},"calculatedAt":{"type":"string","description":"Filter that restricts the search result to key figure results which have been calculated as of this date (format: YYYY-MM-DD HH:II:SS)"},"sortBy":{"type":"array","items":{},"description":"Sort the results options."},"displayZeroPrimaryValue":{"type":"boolean","description":"Display zero results on the UI"}}},"RawDataSearchResult":{"type":"object","properties":{"after":{"type":"string","description":"The last evaluated key as base64, provide that as the starting point for the next query (pagination)."}}},"RawDataConfigs":{"type":"object","properties":{"plentyIdHash":{"type":"string","description":"The plentymarkets system id hash"}}},"BlogPost":{"type":"object","properties":{"id":{"type":"string","description":""},"plentyIdHash":{"type":"string","description":""},"data":{"type":"string","description":""}}},"Board":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the board"},"boardName":{"type":"string","description":"The name of the board"},"columnsCount":{"type":"integer","description":"The number of columns"},"tasksCount":{"type":"integer","description":"The number of tasks"}}},"BoardColumn":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the board column"},"boardId":{"type":"string","description":"The ID of the board"},"columnName":{"type":"string","description":"The name of the column"},"position":{"type":"integer","description":"The position"}}},"BoardTask":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the board task"},"taskName":{"type":"string","description":"The name of the task"},"description":{"type":"string","description":"The description of the task"},"position":{"type":"integer","description":"The position of the task"},"columnId":{"type":"string","description":"The ID of the column"},"boardId":{"type":"string","description":"The ID of the board"}}},"BoardTaskReference":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the board task reference"},"taskId":{"type":"string","description":"The ID of the task to create a reference for"},"referenceValue":{"type":"string","description":"Reference type followed by foreign ID of the referenced object. Syntax: TYPE-ID Example: user-123456 Types: user,ticket,contact,order,item"}}},"Catalog":{"type":"object","properties":{"data":{"type":"array","items":{},"description":"Contains the mappings and template settings"},"settings":{"type":"array","items":{},"description":"Contains the settings"},"name":{"type":"string","description":"The name of the catalogue"},"template":{"type":"string","description":"The id of the template that was used to create the catalogue"},"id":{"type":"string","description":"The id of the catalogue"},"active":{"type":"boolean","description":"Determines whether a catalogue can be exported"},"with":{"type":"array","items":{},"description":"Contains the data attached to the catalog"},"showMandatoryFields":{"type":"boolean","description":"Determines if only the mandatory fields should be displayed in the catalogue UI"},"updatedAt":{"type":"string","description":"The updated at date in W3C"},"createdAt":{"type":"string","description":"The created at date in W3C"},"errors":{"type":"array","items":{},"description":""},"errorCount":{"type":"integer","description":""}}},"DeleteResponse":{"type":"object","properties":{}},"Category":{"type":"object","properties":{}},"CategoryDetails":{"type":"object","properties":{"categoryId":{"type":"integer","description":"The unique ID of the category these category details belong to"},"plentyId":{"type":"integer","description":"The unique plenty ID of the client (store) in which the category is visible. If a subcategory is linked to a client, its parent categories will be linked to this client as well."},"lang":{"type":"string","description":"The <a href=\"https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#languages\" target=\"_blank\">language<\/a> of the category"},"name":{"type":"string","description":"The name of the category. The same category name can be used more than once in different categories or on different category levels. However, category names must be unique within the same category or level."},"description":{"type":"string","description":"The category text. The description is inserted into the online store using template variables."},"description2":{"type":"string","description":"The category text 2. The description 2 is inserted into the online store using template variables."},"shortDescription":{"type":"string","description":"The short description of the category. The short description can be inserted into the store's design using template variables."},"metaKeywords":{"type":"string","description":"HTML meta keywords to tag the category for search engines. More than one keyword can be separated by commas."},"metaDescription":{"type":"string","description":"The meta description of the category. 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."},"nameUrl":{"type":"string","description":"The category name to be used for the category's URL. The same URL name can be used more than once in different categories or on different category levels. However, URL names must be unique within the same category or level. The URL name should not be changed once the category is indexed by search engines. If no URL name is specified, the name will automatically be used as the URL name when the category is created.<br \/>Important: Name should contain ASCII code only and no special characters. The following character strings may not be used as prefixes to URL names: a-, b-, c-, f-, fa-, p-, t-. These prefixes will be removed automatically. For instance, a-class will be changed to class automatically. However, the URL name aclass can be used for a category named A-class."},"metaTitle":{"type":"string","description":"This will be displayed as the title of a tab in the web browser and as a search result in search engines. If this is left blank, the category name will be used as the title. Current recommended limit is 50 characters. Longer titles will be cut off."},"image":{"type":"string","description":"The ID to the image1 of the category."},"image2":{"type":"string","description":"The ID to the image2 of the category."},"imagePath":{"type":"string","description":"The path to the image1 of the category."},"image2Path":{"type":"string","description":"The path to the image2 of the category."},"previewUrl":{"type":"string","description":"The category's URL."},"position":{"type":"integer","description":"The position of the category within a category level."},"itemListView":{"type":"string","description":"The template the category is linked to for the category overview. The template determines what the category overview will look like for this category. This option is available for categories of the type <strong>Item<\/strong> only. Possible values: ItemViewCategoriesList, ItemViewCategoriesList2 to ItemViewCategoriesList10."},"singleItemView":{"type":"string","description":"The template the category is linked to for the single item view. The template determines the appearance of the single item design for this category. This option is available for categories of the type <strong>Item<\/strong> only. Possible values: ItemViewSingleItem, ItemViewSingleItem2 to ItemViewSingleItem5."},"pageView":{"type":"string","description":""},"fulltext":{"type":"boolean","description":"Flag that indicates if the complete category text, i.e. the complete description, will be searched.<ul><li>Y = Complete text will be searched.<\/li><li>N = Text will not be searched completely.<\/li><\/ul>"},"metaRobots":{"type":"string","description":"Values from the meta element Robots are analyzed by Web crawlers. These values tell the crawler what it should do with the page and with the links on the page.<ul><li>all = Include this category in the search engine index and follow the links on the page.<\/li><li>index = Include in the search engine index.<\/li><li>nofollow = Do not follow the links on the page.<\/li><li>noindex = Do not include in the search engine index.<\/li><li>nofollow, noindex = Do not follow the links and do not include the category in the search engine index.<\/li><\/ul>"},"canonicalLink":{"type":"string","description":"The URL of any category that contains the same content. This\nwill avoid duplicate content."},"updatedAt":{"type":"string","description":"The time the category details were last updated"},"updatedBy":{"type":"string","description":"The user who last updated the category details"}}},"CategoryClient":{"type":"object","properties":{"plentyId":{"type":"integer","description":"The unique plenty ID of the client (store) in which the category is visible. Several IDs can be separated by commas. If a subcategory is linked to a client, its parent categories will be linked to this client as well."}}},"CategoryProperty":{"type":"object","properties":{"categoryId":{"type":"integer","description":"The unique ID of the category"},"marketId":{"type":"number","description":"The unique ID of the referrer"},"plentyId":{"type":"integer","description":"The unique plenty ID of the client (store)"},"value":{"type":"string","description":"The category of the referrer"}}},"Document":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the document"},"type":{"type":"string","description":"The type of the document. The following types are available:\n<ul>\n <li>admin<\/li>\n <li>blog<\/li>\n <li>category<\/li>\n <li>correction_document<\/li>\n <li>credit_note<\/li>\n <li>credit_note_external<\/li>\n <li>customer<\/li>\n <li>delivery_note<\/li>\n <li>dunning_letter<\/li>\n <li>ebics_hash<\/li>\n <li>facet<\/li>\n <li>invoice<\/li>\n <li>invoice_external<\/li>\n <li>pos_invoice<\/li>\n <li>pos_invoice_cancellation<\/li>\n <li>item<\/li>\n <li>multi_credit_note<\/li>\n <li>multi_invoice<\/li>\n <li>offer<\/li>\n <li>order_confirmation<\/li>\n <li>pickup_delivery<\/li>\n <li>receipt<\/li>\n <li>refund_reversal<\/li>\n <li>reorder<\/li>\n <li>repair_bill<\/li>\n <li>return_note<\/li>\n <li>reversal_document<\/li>\n <li>settlement_report<\/li>\n <li>success_confirmation<\/li>\n <li>ticket<\/li>\n <li>webshop<\/li>\n <li>webshop_customer<\/li>\n <li>z_report<\/li>\n <li>shipping_label<\/li>\n <li>shipping_export_label<\/li>\n <li>returns_label<\/li>\n <li>reversal_dunning_letter<\/l>\n<\/ul>"},"number":{"type":"integer","description":"The document number"},"numberWithPrefix":{"type":"string","description":"The document number with prefix"},"path":{"type":"string","description":"The path to the document"},"userId":{"type":"integer","description":"The ID of the user"},"source":{"type":"string","description":"The source where the document was generated. Possible sources are 'klarna',\n'soap', 'admin', 'hitmeister', 'paypal' and 'rest'."},"displayDate":{"type":"string","description":"The date displayed on the document"},"status":{"type":"string","description":"The generation status of the document\n(\"pending\", \"faulty\", \"done\" or \"deleted\")"},"content":{"type":"string","description":"The base64 encoded content of the document."}}},"StreamedResponse":{"type":"object","properties":{}},"CategoryTemplate":{"type":"object","properties":{"categoryId":{"type":"integer","description":"The unique ID of the category"},"plentyId":{"type":"integer","description":"The unique plenty ID of the client (store)"},"lang":{"type":"string","description":"The language of the template"},"content":{"type":"string","description":"The content of the template"}}},"PaginationResponse":{"type":"object","properties":{}},"CategoryBranch":{"type":"object","properties":{"categoryId":{"type":"integer","description":"The ID of the category"},"category1Id":{"type":"integer","description":"The ID of the category tree's 1st level. If 1st value is identical to category ID, category is of this level."},"category2Id":{"type":"integer","description":"The ID of the category tree's 2nd level. If 2nd level value is identical to category ID, category is of this level. If 2nd level value is <strong>null<\/strong>, category is of a higher level."},"category3Id":{"type":"integer","description":"The ID of the category tree's 3rd level. If 3rd level value is identical to category ID, category is of this level. If 2nd level value is <strong>null<\/strong>, category is of a higher level."},"category4Id":{"type":"integer","description":"The ID of the category tree's 4th level. If 4th level value is identical to category ID, category is of this level. If 2nd level value is <strong>null<\/strong>, category is of a higher level."},"category5Id":{"type":"integer","description":"The ID of the category tree's 5th level. If 5th level value is identical to category ID, category is of this level. If 2nd level value is <strong>null<\/strong>, category is of a higher level."},"category6Id":{"type":"integer","description":"The ID of the category tree's 6th level. If 6th level value is identical to category ID, category is of this level. If 2nd level value is <strong>null<\/strong>, category is of a higher level."}}},"Comment":{"type":"object","properties":{}},"Conversation":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the conversation"},"shortId":{"type":"string","description":"The Short ID of the Conversation"},"plentyIdHash":{"type":"string","description":"The plentyIdHash"},"plentyId":{"type":"integer","description":"The plentyId of the relation contact"},"inboxId":{"type":"string","description":"The inboxId from the assistant"},"title":{"type":"string","description":"The Title of the Conversation"},"tagIds":{"type":"array","items":{},"description":"Array of tag IDs"},"isClosed":{"type":"boolean","description":"Boolean that indicates if the conversation is closed"},"isDeleted":{"type":"boolean","description":"Boolean that indicates if the conversation is deleted"},"readBy":{"type":"array","items":{},"description":"Array of user ids (int)"},"":{"type":"boolean","description":"validRelation Conversation has the relations validated"},"priorityId":{"type":"string","description":"The Priority of the Conversation"},"typeId":{"type":"integer","description":"ID of conversation type"},"typePosition":{"type":"integer","description":"Sort order of conversation type"},"statusId":{"type":"integer","description":"ID of conversation status"},"statusPosition":{"type":"integer","description":"Sort order of conversation status"},"hasWhisperedMessages":{"type":"boolean","description":"Flag that indicates if a conversation contains whispered messages"},"messagesTitles":{"type":"array","items":{},"description":"Array of all message titles"},"messagesBodies":{"type":"array","items":{},"description":"Array with all message bodies stripped of tags"},"messagesTags":{"type":"array","items":{},"description":"Array with all tag ID's from all messages"},"replyTo":{"type":"array","items":{},"description":""},"messagesPaths":{"type":"array","items":{},"description":"Array with s3 messages paths"},"messagesIds":{"type":"array","items":{},"description":"Array with all messages UUID's"},"isMigratedToEs":{"type":"integer","description":"Flag that indicates if the conversation is synced to ES (used during messenger migration to new structure)"},"isArchived":{"type":"boolean","description":"Flag that indicates if the conversation is archived"},"isSpam":{"type":"boolean","description":"Flag that indicates if the conversation is spam"},"conversationPreview":{"type":"string","description":"Strip last the message from messagesBodies to 200 characters, used for preview."},"categoryId":{"type":"integer","description":"Conversation category ID"},"linkedFolders":{"type":"array","items":{},"description":"List of linked folders"},"marketplacesMetadata":{"type":"array","items":{},"description":"marketplaces Meta data"},"privateUserId":{"type":"integer","description":"Private user ID"}}},"ConversationCategory":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the type"},"position":{"type":"integer","description":"The position of the type (used in sorting)"},"userId":{"type":"integer","description":"The user ID which performed the last update"},"icon":{"type":"string","description":"The icon for messenger tab"},"iconType":{"type":"string","description":"The icon type"},"isDeleted":{"type":"boolean","description":"Flag that indicates if the type was deleted"},"isEnabled":{"type":"boolean","description":"Flag that indicates if the type is enabled"}}},"ConversationEvent":{"type":"object","properties":{"id":{"type":"integer","description":""},"name":{"type":"string","description":""},"description":{"type":"string","description":""},"eventClass":{"type":"string","description":""},"isActive":{"type":"boolean","description":""},"userId":{"type":"integer","description":""},"updatedAt":{"type":"string","description":""},"executedAt":{"type":"string","description":""}}},"ConversationFolder":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the folder"},"name":{"type":"string","description":"The name of the folder"},"userId":{"type":"integer","description":"The user ID which is the folder owner"}}},"ConversationRole":{"type":"object","properties":{"id":{"type":"integer","description":""},"position":{"type":"integer","description":""},"userId":{"type":"integer","description":""},"isDeleted":{"type":"boolean","description":""}}},"ConversationStatus":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the status"},"position":{"type":"integer","description":"The position of the status (used in sorting)"},"userId":{"type":"integer","description":"The suer ID which performed the last update"},"isDeleted":{"type":"boolean","description":"Flag that indicates if the status was deleted"},"":{"type":"string","description":"colour Color of the status background (example: #0084ff)"}}},"ConversationType":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the type"},"position":{"type":"integer","description":"The position of the type (used in sorting)"},"userId":{"type":"integer","description":"The suer ID which performed the last update"},"isDeleted":{"type":"boolean","description":"Flag that indicates if the type was deleted"},"categoryId":{"type":"boolean","description":"The ID of the parent category"}}},"CreditNoteReason":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the credit note reason."},"reason":{"type":"string","description":"The specified reason in system language."}}},"DeleteLog":{"type":"object","properties":{"referenceType":{"type":"integer","description":"The type of the deleted record<ul><li>1 = Category<\/li><li>2 = Payment<\/li><li>3 = Order<\/li><li>4 = Customer<\/li><li>5 = Item<\/li><li>6 = Facet of the type Attribute<\/li><li>7 = Facet of the type Property<\/li><li>8 = Facet of the type Manufacturer<\/li><li>9 = Facet of the type Availability<\/li><li>10 = Unit<\/li><li>11 = Sales price<\/li><li>12 = Sales price link to variation<\/li><li>13 = Item variation<\/li><\/ul>13 = Order item<\/li><\/ul>"},"referenceValue":{"type":"integer","description":"The ID of the deleted record"},"userRealName":{"type":"string","description":"The real name of the user who deleted the record"},"updatedAt":{"type":"string","description":"The date and time that the record was deleted"},"userId":{"type":"integer","description":"The ID of the user who deleted the record"}}},"StockIntakeDocumentGenerationPreview":{"type":"object","properties":{"hash":{"type":"string","description":""},"content":{"type":"string","description":""},"status":{"type":"integer","description":""},"orderId":{"type":"integer","description":""}}},"DocumentGenerationPreview":{"type":"object","properties":{"hash":{"type":"string","description":""},"content":{"type":"string","description":""},"status":{"type":"integer","description":""},"orderId":{"type":"integer","description":""}}},"DocumentGeneration":{"type":"object","properties":{"id":{"type":"integer","description":""},"status":{"type":"integer","description":""}}},"ElasticSyncSync":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the elastic sync sync"},"name":{"type":"string","description":"The name of the elastic sync sync"},"syncType":{"type":"string","description":"The type of the elastic sync sync"},"sourceType":{"type":"string","description":"The source type of the elastic sync sync"},"sourceDataType":{"type":"string","description":"The source data type of the elastic sync sync"}}},"ElasticSyncMappingFilter":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the elastic sync mapping filter"},"mappingId":{"type":"integer","description":"The ID of the elastic sync mapping"},"type":{"type":"string","description":"The type of the elastic sync mapping filter"},"operator":{"type":"string","description":"The operator of the elastic sync mapping filter"},"source":{"type":"string","description":"The source of the elastic sync mapping filter"},"value":{"type":"string","description":"The value of the elastic sync mapping filter"}}},"ElasticSyncMappingRow":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the elastic sync mapping row"},"mappingId":{"type":"integer","description":"The ID of the elastic sync mapping"},"targetModel":{"type":"string","description":"The target model of the elastic sync mapping row"},"targetAttribute":{"type":"string","description":"The target attribute of the elastic sync mapping row"},"active":{"type":"boolean","description":"The state of the elastic sync mapping row"},"entityType":{"type":"string","description":"The entity type of the elastic sync mapping row (array values: 'ownValue', 'ownAssignment', 'regularExpression', 'csvColumn')"},"value":{"type":"string","description":"The value of the elastic sync mapping row"},"settings":{"type":"string","description":"The settings of the elastic sync mapping row"},"identifiers":{"type":"string","description":"The identifiers of the elastic sync mapping row"}}},"ElasticSyncMapping":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the elastic sync mapping"},"syncId":{"type":"integer","description":"The ID of the elastic sync sync"},"name":{"type":"string","description":"The name of the elastic sync mapping"},"position":{"type":"integer","description":"The position of the elastic sync mapping"},"active":{"type":"boolean","description":"The state of the elastic sync mapping"}}},"ElasticSyncMatching":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the elastic sync matching"},"syncId":{"type":"integer","description":"The ID of the elastic sync sync"},"target":{"type":"string","description":"The target of the elastic sync matching"},"source":{"type":"string","description":"The source of the elastic sync matching"},"additionalValue":{"type":"string","description":"The additional value of the elastic sync matching"}}},"ElasticSyncOption":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the elastic sync option"},"syncId":{"type":"integer","description":"The ID of the elastic sync sync"},"optionIdentifier":{"type":"string","description":"The option identifier of the elastic sync option"},"key":{"type":"string","description":"The key of the elastic sync option"},"value":{"type":"string","description":"The value of the elastic sync option"}}},"Export":{"type":"object","properties":{"id":{"type":"integer","description":"export id"},"name":{"type":"string","description":"export name"},"type":{"type":"string","description":"export type"},"limit":{"type":"integer","description":"maximum number of entries"},"createdAt":{"type":"string","description":"created at date timestamp"},"updatedAt":{"type":"string","description":"last update date timestamp"},"formatKey":{"type":"string","description":"the format key"},"outputType":{"type":"string","description":"the output type"},"generateCache":{"type":"integer","description":"if cache should be generated"}}},"Filter":{"type":"object","properties":{"id":{"type":"integer","description":"filter id"},"createdAt":{"type":"string","description":"created at date timestamp"},"updatedAt":{"type":"string","description":"last update date timestamp"},"exportId":{"type":"integer","description":"depending export id"},"key":{"type":"string","description":"filter key"},"value":{"type":"string","description":"filter value"}}},"FormatSetting":{"type":"object","properties":{"id":{"type":"integer","description":"format setting id"},"createdAt":{"type":"string","description":"created at date timestamp"},"updatedAt":{"type":"string","description":"last update date timestamp"},"exportId":{"type":"integer","description":"depending export id"},"key":{"type":"string","description":"format setting key"},"value":{"type":"string","description":"format setting value"}}},"OutputParam":{"type":"object","properties":{"id":{"type":"integer","description":"output param id"},"createdAt":{"type":"string","description":"created at date timestamp"},"updatedAt":{"type":"string","description":"last update date timestamp"},"exportId":{"type":"integer","description":"depending export id"},"key":{"type":"string","description":"output param key"},"value":{"type":"string","description":"output param value"}}},"FeedbackComment":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the comment"},"message":{"type":"string","description":"The message of the comment"},"isVisible":{"type":"boolean","description":"If true, the comment is visible"}}},"Feedback":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the feedback"},"title":{"type":"string","description":"The title of the feedback"},"authorName":{"type":"string","description":"The name of the feedback's author"},"isVisible":{"type":"boolean","description":"If true, the feedback is visible"}}},"FeedbackRating":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the rating"},"ratingValue":{"type":"string","description":"The value of the rating"},"isVisible":{"type":"boolean","description":"If true, the rating is visible"}}},"PickingOrderItem":{"type":"object","properties":{"id":{"type":"integer","description":""},"pickingOrderId":{"type":"integer","description":""},"orderItemId":{"type":"integer","description":""},"processState":{"type":"string","description":""},"processDate":{"type":"string","description":""},"processUserId":{"type":"integer","description":""},"comment":{"type":"string","description":""},"quantity":{"type":"number","description":""},"itemId":{"type":"integer","description":""},"holdingArea":{"type":"integer","description":""},"warehouseId":{"type":"integer","description":""},"orderIdList":{"type":"string","description":""}}},"PickingOrder":{"type":"object","properties":{"id":{"type":"integer","description":""},"createdAt":{"type":"string","description":""},"processDate":{"type":"string","description":""},"doneDate":{"type":"string","description":""},"ownerId":{"type":"integer","description":""},"processUserId":{"type":"integer","description":""},"processState":{"type":"string","description":""},"webstoreId":{"type":"integer","description":""},"warehouseId":{"type":"integer","description":""},"comment":{"type":"string","description":""},"filterOptions":{"type":"array","items":{},"description":""}}},"Credentials":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the credentials."},"environment":{"type":"string","description":"The environment for the credentials. Possible values: sandbox, production"},"status":{"type":"string","description":"The status of the credentials. Possible values: active, inactive, pending"},"data":{"type":"array","items":{},"description":"The data of the credentials."},"market":{"type":"string","description":"The market for the current credentials."},"createdAt":{"type":"string","description":"The date that the credentials was created."},"updatedAt":{"type":"string","description":"The date that the credentials was updated last."}}},"ItemSet":{"type":"object","properties":{"id":{"type":"integer","description":"The item ID of the item set. The ID must be unique."},"name":{"type":"string","description":"The name of the item set. The default language of the system is used."},"categories":{"type":"array","items":{},"description":"The array with categories of the item set. The category ID key \"categoryId\" must be specified. Example for JSON Object: \"categories\":[{\"categoryId\":\"34\"},{\"categoryId\":\"35\"}]}]"}}},"ItemSetComponent":{"type":"object","properties":{"id":{"type":"integer","description":"The item set component ID. The ID must be unique."},"setId":{"type":"integer","description":"The item ID of the item set. The ID must be unique."},"itemId":{"type":"integer","description":"The item ID of the set component"},"minimalOrderQuantity":{"type":"number","description":"Minimum order quantity."},"maximumOrderQuantity":{"type":"number","description":"Maximum order quantity."},"orderQuantityPossible":{"type":"boolean","description":"Order quantities possible."}}},"ItemSetConfig":{"type":"object","properties":{"setId":{"type":"integer","description":"set id The item ID of the item set. The ID must be unique."},"rebate":{"type":"number","description":"The discount in percent to be subtracted from the sum of the prices of the selected set components."}}},"Item":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the item. The ID must be unique."},"position":{"type":"integer","description":"The position of the item"},"itemType":{"type":"string","description":"The type of the item. Because Set items are managed using a separate route,\nthis value is always Default."},"stockType":{"type":"integer","description":"The stock type of the item. Possible values:\n<ul><li>0 = Stocked item (default)<\/li>\n <li>1 = Production item<\/li>\n <li>2 = Colli<\/li>\n <li>3 = Special order item<\/li><\/ul>"},"storeSpecial":{"type":"integer","description":"Option to present items more prominently in the online store.\n<ul><li>1 = Special offer<\/li><li>2 = New items<\/li><li>3 = Top items<\/li><\/ul>"},"ownerId":{"type":"integer","description":"The plentymarkets user that is assigned as owner of this item."},"manufacturerId":{"type":"integer","description":"The ID of the manufacturer of the item"},"producingCountryId":{"type":"integer","description":"The ID of the country in which the item was manufactured."},"mainVariationId":{"type":"integer","description":"The ID of the main variation of the item. The ID must be unique."},"revenueAccount":{"type":"integer","description":"The revenue account the item is linked to.\nAn individual revenue account can be saved for each item in plentymarkets.\nIf this is not done, plentymarkets automatically determines a revenue account\nbased on the VAT rate."},"couponRestriction":{"type":"integer","description":"Indicates if the item can be purchased using a promotional coupon.\n<ul><li>0 = Permitted<\/li>\n <li>1 = Not permitted<\/li>\n <li>2 = Purchasable with coupon only<\/li><\/ul>"},"condition":{"type":"integer","description":"The condition of the item. Possible values:\n<ul><li>0 = New<\/li><li>1 = Used<\/li>\n <li>2 = Boxed as new<\/li>\n <li>3 = New with label<\/li>\n <li>4 = Factory seconds<\/li><\/ul>"},"conditionApi":{"type":"integer","description":"The condition of the item that is transferred to markets via API.\n<ul><li>0 = New<\/li>\n <li>1 = Used but as new<\/li>\n <li>2 = Used but very good<\/li>\n <li>3 = Used but good<\/li>\n <li>4 = Used but acceptable<\/li>\n <li>5 = Factory seconds<\/li><\/ul>"},"createdAt":{"type":"string","description":"Timestamp of the date and time the item was created."},"updatedAt":{"type":"string","description":"Timestamp of the last date and time the item was updated."},"isSubscribable":{"type":"boolean","description":"Flag that indicates if the item can be ordered as a subscription item.\nIf yes, the item can be ordered for delivery at regular intervals."},"isSerialNumber":{"type":"boolean","description":"Flag that indicates if serial numbers are to be assigned to variations of this item\nto uniquely identify every item sold. Serial numbers ensure traceability of an item\nin case of errors or problems."},"isShippingPackage":{"type":"boolean","description":"Flag that indicates if a shipping package is to be used for this item.\nIf yes and the variation's dimensions are entered in the <b>Settings<\/b> tab of a\nvariation, the correct shipping package is assigned automatically."},"amazonFbaPlatform":{"type":"integer","description":"Indicates the platform used for Fulfilment by Amazon (FBA).\n<ul><li>0 = Do not use<\/li>\n <li>1 = AMAZON EU (Europe)<\/li>\n <li>2 = AMAZON FE (Far East)<\/li>\n <li>3 = AMAZON NA (North America)<\/li><\/ul>"},"isShippableByAmazon":{"type":"boolean","description":"Flag that indicates if the item can be shipped with Amazon Multi-Channel.\nAmazon Multi-Channel Fulfillment is a service for fulfilling orders from sales\nchannels other than Amazon platforms using inventory stored in the Amazon\nfulfillment center."},"amazonProductType":{"type":"integer","description":"The Amazon product type of the item (deprecated as of June 2025). List of IDs:\nhttps:\/\/www.plentymarkets.co.uk\/manual\/data-exchange\/data-formats\/item\/"},"amazonProductType2":{"type":"string","description":"The new Amazon product type of the item."},"amazonFedas":{"type":"string","description":"The FEDAS product classification key of the item."},"ebayPresetId":{"type":"integer","description":"The eBay preset ID. This plentymarkets ID must be specified to save values for\n$ebayCategory, $ebayCategory2, $ebayStoreCategory and $ebayStoreCategory2."},"ebayCategory":{"type":"integer","description":"The eBay category 1 of the item. This category is used when a new listing is created."},"ebayCategory2":{"type":"integer","description":"The eBay category 2 of the item. This category is used when a new listing is created."},"ebayStoreCategory":{"type":"integer","description":"The ID of the eBay store category 1 of the item.\nThis value is used for new listings."},"ebayStoreCategory2":{"type":"integer","description":"The ID of the eBay store category 2 of the item.\nThis value is used for new listings."},"rakutenCategoryId":{"type":"integer","description":"The ID of the Rakuten category of this item."},"flagOne":{"type":"integer","description":"Flag 1 of the item. Flags can be used to organise and filter items.\nEach item can be assigned up to two flags. Possible values: 1 to 31, 0 = no flag"},"flagTwo":{"type":"integer","description":"Flag 2 of the item. Flags can be used to organise and filter items.\nEach item can be assigned up to two flags. Possible values: 1 to 11, 0 = no flag"},"ageRestriction":{"type":"integer","description":"The age customers must be to purchase the item.\nItems with an age rating of 18+ must be linked to a shipping profile for which the\nPostIdent option is activated.\n<ul><li>0 = None available<\/li>\n <li>3 = Released for ages 3 and up<\/li>\n <li>6 = Ages 6 and up<\/li>\n <li>9 = Ages 9 and up<\/li>\n <li>12 = Ages 12 and up<\/li>\n <li>14 = Ages 14 and up<\/li>\n <li>16 = Ages 16 and up<\/li>\n <li>18 = Ages 18 and up<\/li>\n <li>50 = Not marked<\/li>\n <li>88 = Not required<\/li>\n <li>99 = Unknown<\/li><\/ul>"},"feedback":{"type":"integer","description":"The feedback, i.e. rating, that this item received.\nPossible values are 1 to 5 or 1 to 10 depending on the maximum rating setting.\nAn initial feedback can be saved for items. The saved value will then be displayed as the\ninitial feedback. Every time new feedback is submitted, the average value will be\nrecalculated automatically."},"free1":{"type":"string","description":"The content of the free text field 1. This can be displayed in the online store or on eBay."},"free2":{"type":"string","description":"The content of the free text field 2. This can be displayed in the online store or on eBay."},"free3":{"type":"string","description":"The content of the free text field 3. This can be displayed in the online store or on eBay."},"free4":{"type":"string","description":"The content of the free text field 4. This can be displayed in the online store or on eBay."},"free5":{"type":"string","description":"The content of the free text field 5. This can be displayed in the online store or on eBay."},"free6":{"type":"string","description":"The content of the free text field 6. This can be displayed in the online store or on eBay."},"free7":{"type":"string","description":"The content of the free text field 7. This can be displayed in the online store or on eBay."},"free8":{"type":"string","description":"The content of the free text field 8. This can be displayed in the online store or on eBay."},"free9":{"type":"string","description":"The content of the free text field 9. This can be displayed in the online store or on eBay."},"free10":{"type":"string","description":"The content of the free text field 10. This can be displayed in the online store or on eBay."},"free11":{"type":"string","description":"The content of the free text field 11. This can be displayed in the online store or on eBay."},"free12":{"type":"string","description":"The content of the free text field 12. This can be displayed in the online store or on eBay."},"free13":{"type":"string","description":"The content of the free text field 13. This can be displayed in the online store or on eBay."},"free14":{"type":"string","description":"The content of the free text field 14. This can be displayed in the online store or on eBay."},"free15":{"type":"string","description":"The content of the free text field 15. This can be displayed in the online store or on eBay."},"free16":{"type":"string","description":"The content of the free text field 16. This can be displayed in the online store or on eBay."},"free17":{"type":"string","description":"The content of the free text field 17. This can be displayed in the online store or on eBay."},"free18":{"type":"string","description":"The content of the free text field 18. This can be displayed in the online store or on eBay."},"free19":{"type":"string","description":"The content of the free text field 19. This can be displayed in the online store or on eBay."},"free20":{"type":"string","description":"The content of the free text field 20. This can be displayed in the online store or on eBay."},"maximumOrderQuantity":{"type":"number","description":"The maximum order quantity of an item permitted per order.\nIf a maximum order quantity is specified, no more than this quantity of any\ncombination of the variations of the item can be ordered.\nDecimal values are possible to allow orders by weight or length.\nDefault value is 0. If value is 0, the maximum order quantity is unlimited."},"customsTariffNumber":{"type":"string","description":"Deprecated: The customs tariff number of the item;\nusually a 11 digit code number based on the Harmonised System"}}},"ItemEbayTitle":{"type":"object","properties":{"title":{"type":"string","description":"The title."},"itemId":{"type":"integer","description":"The unique ID of the item."},"id":{"type":"integer","description":"The unique ID of the ebay title."}}},"ItemShippingProfiles":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the link between item and shipping profile"},"itemId":{"type":"integer","description":"The unique ID of the item"},"profileId":{"type":"integer","description":"The unique ID of the shipping profile"}}},"ItemProperty":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the variation property value"},"itemId":{"type":"integer","description":"The id of the variation"},"propertyId":{"type":"integer","description":"The id of the property item"},"propertySelectionId":{"type":"integer","description":"The id of the property selection"},"valueInt":{"type":"integer","description":"The int value of the variation property value"},"valueFloat":{"type":"number","description":"The float value of the variation property value"},"valueFile":{"type":"string","description":"The file value of the variation property value"},"surcharge":{"type":"number","description":"The surcharge of the variation property value"}}},"Variation":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the variation."},"elasticSearchSource":{"type":"array","items":{},"description":""}}},"AttributeValueName":{"type":"object","properties":{"valueId":{"type":"integer","description":"The unique ID of the attribute value."},"lang":{"type":"string","description":"The <a href=\"https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#countries\" target=\"_blank\">language<\/a> of the attribute value."},"name":{"type":"string","description":"The name of the attribute value. This attribute value name is displayed in the online store."}}},"Attribute":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the attribute."},"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."},"position":{"type":"integer","description":"The position of the attribute. Attributes are displayed in the attribute overview in ascending order by position."},"isSurchargePercental":{"type":"boolean","description":"Flag that indicates if the surcharge is percental."},"isLinkableToImage":{"type":"boolean","description":"Flag that indicates if an image can be linked to the attribute."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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."}}},"AttributeMap":{"type":"object","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."},"marketInformation1":{"type":"string","description":"The information regarding the marketplace."},"marketInformation2":{"type":"string","description":"The information regarding the marketplace."}}},"AttributeValueMap":{"type":"object","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."},"marketInformation1":{"type":"string","description":"The information regarding the marketplace."},"marketInformation2":{"type":"string","description":"The information regarding the marketplace."}}},"AttributeName":{"type":"object","properties":{"attributeId":{"type":"integer","description":"The id of the attribute."},"lang":{"type":"string","description":"The <a href=\"https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#countries\" target=\"_blank\">language<\/a> of the attribute."},"name":{"type":"string","description":"The name of the attribute. This attribute name is displayed in the online store."}}},"AttributeValueMarketName":{"type":"object","properties":{"valueId":{"type":"integer","description":"The unique ID of the attribute value."},"lang":{"type":"string","description":"The <a href=\"https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#countries\" target=\"_blank\">language<\/a> 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."},"attributeId":{"type":"integer","description":""},"referenceType":{"type":"string","description":""}}},"AttributeValue":{"type":"object","properties":{}},"Barcode":{"type":"object","properties":{}},"BarcodeLinkReferrer":{"type":"object","properties":{"barcodeId":{"type":"integer","description":"The unique ID of the barcode"},"referrerId":{"type":"number","description":"The unique ID of the referrer. To activate all referrers, the value <strong>-1<\/strong> must be specified. This value activates all referrers in the system by default, including any referrers added at a later stage."},"createdAt":{"type":"string","description":"The time the barcode was created."},"updatedAt":{"type":"string","description":"The time the barcode was last updated."}}},"ItemListingCategory":{"type":"object","properties":{"id":{"type":"integer","description":""},"name":{"type":"string","description":""},"fullName":{"type":"string","description":""},"parentId":{"type":"integer","description":""},"isLeaf":{"type":"boolean","description":""}}},"Manufacturer":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the manufacturer."},"name":{"type":"string","description":"The name of the manufacturer"},"legalName":{"type":"string","description":"The legal name of the manufacturer"},"externalName":{"type":"string","description":"The external name of the manufacturer. The external name is used for the item export to external markets. If no external name is saved, the Name will be used. The external name will also be transferred to FINDOLOGIC and will be indexed for item searches."},"logo":{"type":"string","description":"The URL of the manufacturer's logo"},"url":{"type":"string","description":"The URL of the manufacturer's website"},"contactUrl":{"type":"string","description":"The Contact URL of the manufacturer's website"},"street":{"type":"string","description":"The street of the manufacturer's address"},"houseNo":{"type":"string","description":"The house number of the manufacturer's address"},"postcode":{"type":"string","description":"The postal code of the manufacturer's address"},"town":{"type":"string","description":"The town of the manufacturer's address"},"phoneNumber":{"type":"string","description":"The phone number of the manufacturer"},"faxNumber":{"type":"string","description":"The fax number of the manufacturer"},"email":{"type":"string","description":"The email address of the manufacturer"},"countryId":{"type":"integer","description":"The ID of the <a href=\"https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#countries\" target=\"_blank\">country<\/a> in which the manufacturer is based; 0 = unknown."},"pixmaniaBrandId":{"type":"integer","description":"The manufacturer's ID on the market Pixmania"},"neckermannAtEpBrandId":{"type":"integer","description":"The manufacturer's ID on the market Neckermann Austria, Enterprise version"},"laRedouteBrandId":{"type":"integer","description":"The manufacturer's ID on the market La Redoute"},"position":{"type":"integer","description":"The position of the manufacturer"},"comment":{"type":"string","description":"Internal comments about the manufacturer (optional)"},"updatedAt":{"type":"string","description":"The time the manufacturer information was last updated."},"responsibleName":{"type":"string","description":"The name of the EU-Responsible person"},"responsibleStreet":{"type":"string","description":"The street of the EU-Responsible person"},"responsibleHouseNo":{"type":"string","description":"The house number of the EU-Responsible person"},"responsiblePostCode":{"type":"string","description":"The postal code of the EU-Responsible person"},"responsibleTown":{"type":"string","description":"The town of the EU-Responsible person"},"responsibleCountry":{"type":"integer","description":"The country of the EU-Responsible person"},"responsibleEmail":{"type":"string","description":"The email address of the EU-Responsible person"},"responsibleContactUrl":{"type":"string","description":"The contact form the EU-Responsible person"},"responsiblePhoneNo":{"type":"string","description":"The phone number of the EU-Responsible person"}}},"ManufacturerCommission":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the manufacturer commission"},"manufacturerId":{"type":"integer","description":"The unique ID of the manufacturer"},"plentyId":{"type":"integer","description":"The unique ID of the client (store) that the commission applies to. The route \/rest\/webstores provides access to clients (stores)."},"referrerId":{"type":"number","description":"The unique ID of the referrer that the commission applies to. The route \/rest\/orders\/referrers provides access to referrers."},"commission":{"type":"number","description":"The manufacturer commission value in percent"}}},"PackingUnit":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the packing unit entry. Primary key auto-increment"},"unitId":{"type":"integer","description":"The id of the packing unit as it was until now (from 0 to 39 without 33)"},"unitNameEN":{"type":"string","description":"The name of the packing unit in English"},"unitNameDE":{"type":"string","description":"The name of the packing unit in German"}}},"Property":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property"},"cast":{"type":"string","description":"The cast of the property (array values: 'empty','int','float','string','selection','text','html','date','file')"},"type":{"type":"string","description":"The type of the property (e.g. 'item' or 'contact')"},"position":{"type":"integer","description":"The position of the property"}}},"PropertyMarketReference":{"type":"object","properties":{"propertyId":{"type":"integer","description":"The unique ID of the property"},"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"}}},"PropertyName":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property name"},"propertyId":{"type":"integer","description":"The property ID of the property name"},"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 name"},"description":{"type":"string","description":"The description of the property name"}}},"PropertySelection":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property selection"},"propertyId":{"type":"integer","description":"The property ID of the property selection"},"position":{"type":"integer","description":"The position of the property selection"}}},"PropertyGroup":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property group"},"position":{"type":"integer","description":"The position of the property group"}}},"PropertyGroupName":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property group name"},"groupId":{"type":"integer","description":"The property group 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"}}},"SalesPrice":{"type":"object","properties":{}},"SalesPriceName":{"type":"object","properties":{"salesPriceId":{"type":"integer","description":"The unique ID of the sales price"},"lang":{"type":"string","description":"The <a href='https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#languages' target='_blank'>language code<\/a> 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."},"createdAt":{"type":"string","description":"The time the name was created."},"updatedAt":{"type":"string","description":"The time the name was last updated."}}},"SalesPriceCountry":{"type":"object","properties":{"salesPriceId":{"type":"integer","description":"The unique ID of the sales price"},"countryId":{"type":"integer","description":"The unique ID of the <a href=\"https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#countries\" target=\"_blank\">country<\/a>"},"createdAt":{"type":"string","description":"The time the country was activated."},"updatedAt":{"type":"string","description":"The time the relationship between country and sales price was last updated."}}},"SalesPriceCurrency":{"type":"object","properties":{"salesPriceId":{"type":"integer","description":"The unique ID of the sales price"},"currency":{"type":"string","description":"The ISO code of the <a href=\"https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#currencies\" target=\"_blank\">currency<\/a>; -1 = all currencies."},"createdAt":{"type":"string","description":"The time the currency was activated."},"updatedAt":{"type":"string","description":"The time the relationship between currency and sales price was last updated."}}},"SalesPriceCustomerClass":{"type":"object","properties":{"salesPriceId":{"type":"integer","description":"The unique ID of the sales price"},"customerClassId":{"type":"integer","description":"The unique ID of the customer class"},"createdAt":{"type":"string","description":"The time the customer class was activated."},"updatedAt":{"type":"string","description":"The time the relationship between customer class and sales price was last updated."}}},"SalesPriceReferrer":{"type":"object","properties":{"salesPriceId":{"type":"integer","description":"The unique ID of the sales price"},"referrerId":{"type":"number","description":"The unique ID of the referrer"},"createdAt":{"type":"string","description":"The time the referrer was activated."},"updatedAt":{"type":"string","description":"The time the relationship between referrer and sales price was last updated."}}},"SalesPriceOnlineStore":{"type":"object","properties":{"salesPriceId":{"type":"integer","description":"The unique ID of the sales price"},"plentyId":{"type":"integer","description":"The unique ID of the client (store)"},"createdAt":{"type":"string","description":"The time the client (store) was activated."},"updatedAt":{"type":"string","description":"The time the relationship between the client (store) and the sales price was last updated."}}},"SalesPriceAccount":{"type":"object","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"},"createdAt":{"type":"string","description":"The time the referrer account was linked to the sales price."},"updatedAt":{"type":"string","description":"The time the link was last updated."}}},"Unit":{"type":"object","properties":{}},"UnitName":{"type":"object","properties":{"unitId":{"type":"integer","description":"The unique ID of the unit"},"lang":{"type":"string","description":"The <a href=\"https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#languages\" target=\"_blank\">language<\/a> of the unit name"},"name":{"type":"string","description":"The name of the unit"}}},"VariationBarcode":{"type":"object","properties":{"code":{"type":"string","description":"The code of the variation's barcode. The combination of code and barcode ID must be unique."},"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"},"createdAt":{"type":"string","description":"The time the variation's code was created."}}},"VariationSalesPrice":{"type":"object","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"},"lowestPrice":{"type":"number","description":"The lowest price of the variation saved for this sales price"},"lowestPriceCalculation":{"type":"boolean","description":"Is the lowest price calculation active for this sales price"},"updatedAt":{"type":"string","description":"The time the sales price was last updated."},"createdAt":{"type":"string","description":"The time the sales price was created."}}},"VariationCategory":{"type":"object","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"},"isNeckermannPrimary":{"type":"string","description":"Flag that indicates if the category is the primary category for the market Neckermann for this variation."}}},"VariationClient":{"type":"object","properties":{"variationId":{"type":"integer","description":"The unique ID of the variation"},"plentyId":{"type":"integer","description":"The unique ID of the client (store)"},"createdAt":{"type":"string","description":"The time at which the client (store) was linked to the variation."}}},"VariationMarket":{"type":"object","properties":{"variationId":{"type":"integer","description":"The unique ID of the variation"},"marketId":{"type":"integer","description":"The unique ID of the market"},"createdAt":{"type":"string","description":"The time the link between the variation and the market was created."}}},"VariationDefaultCategory":{"type":"object","properties":{"variationId":{"type":"integer","description":"The unique ID of the variation"},"branchId":{"type":"integer","description":"The unique ID of the category branch"},"plentyId":{"type":"integer","description":"The unique plenty ID of the client (store)"},"manually":{"type":"string","description":""}}},"VariationSupplier":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the link between variation and supplier"},"variationId":{"type":"integer","description":"The unique ID of the variation"},"supplierId":{"type":"integer","description":"The unique ID of the supplier"},"purchasePrice":{"type":"number","description":"The price at which the variation was purchased from this supplier."},"minimumPurchase":{"type":"integer","description":"The minimum quantity of the variation that has to be ordered from the supplier. This value is also used as a quantity suggestion when creating reorders."},"itemNumber":{"type":"string","description":"The external item number assigned to the variation by this supplier"},"lastPriceQuery":{"type":"string","description":"The date of the last price query to this supplier. This helps to plan price negotiations."},"deliveryTimeInDays":{"type":"integer","description":"The delivery time in days for the variation saved for this supplier"},"discount":{"type":"number","description":"The discount in percent the supplier grants for the variation."},"isDiscountable":{"type":"string","description":"Flag that indicates if the supplier's discount for this variation is active."},"packagingUnit":{"type":"number","description":"The packaging unit of the supplier if it differs from the packaging unit settings in plentymarkets."},"lastUpdateTimestamp":{"type":"string","description":"The time the supplier data was last updated"},"createdAt":{"type":"string","description":"The time the supplier data was created"},"currencyPurchasePrice":{"type":"number","description":"The purchase price in the currency of the supplier"},"itemDescription":{"type":"string","description":"The supplier item description"}}},"VariationWarehouse":{"type":"object","properties":{"variationId":{"type":"integer","description":"The unique ID of the variation"},"warehouseId":{"type":"integer","description":"The unique ID of the warehouse"},"warehouseZoneId":{"type":"integer","description":"The unique ID of the warehouse zone"},"storageLocationType":{"type":"string","description":"The storage location type of the warehouse"},"reorderLevel":{"type":"integer","description":"The reorder level for the variation in this warehouse"},"maximumStock":{"type":"integer","description":"The maximum stock for the variation in this warehouse"},"stockTurnoverInDays":{"type":"integer","description":"The stock turnover in days for the variation in this warehouse"},"storageLocation":{"type":"integer","description":"The storage location of the variation in this warehouse"},"stockBuffer":{"type":"integer","description":"The stock buffer for the variation in this warehouse"},"isBatch":{"type":"boolean","description":"Is for warehouse and variation stock batch active"},"isBestBeforeDate":{"type":"boolean","description":"Is for warehouse and variation stock best before date active"},"lastUpdateTimestamp":{"type":"string","description":"The time the warehouse data was last updated."},"createdAt":{"type":"string","description":"The time the warehouse data was created."}}},"AttributeValueSet":{"type":"object","properties":{"attributeValueSetId":{"type":"integer","description":"The ID of the attribute value set"},"attributeId":{"type":"integer","description":"The ID of the attribute"},"valueId":{"type":"integer","description":"The ID of the attribute value"},"isLinkableToImage":{"type":"integer","description":"Flag that indicates if an image can be linked to the attribute."}}},"UnitCombination":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the unitCombination"},"unitId":{"type":"integer","description":"The id of the unit"},"content":{"type":"integer","description":"The content of the unit"}}},"VariationPropertyValueText":{"type":"object","properties":{"valueId":{"type":"integer","description":"The unique ID of the link between the variation and the property"},"lang":{"type":"string","description":"The <a href=\"https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#languages\" target=\"_blank\">language<\/a> of the property value text"},"value":{"type":"string","description":"The text saved for the property of the type Text"}}},"ItemImage":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the image"},"itemId":{"type":"integer","description":"The unique ID of the item the image is associated with"},"fileType":{"type":"string","description":"The file format of the image. Possible file formats: jpg, jpeg, png, gif, svg"},"path":{"type":"string","description":"The path under which the image is saved."},"position":{"type":"integer","description":"The position of the image. The position is used for sorting images in the online store."},"createdAt":{"type":"string","description":"The time the image was uploaded."},"updatedAt":{"type":"string","description":"The time the image details were last updated."},"md5Checksum":{"type":"string","description":"The MD5 hash value of the image file"},"md5ChecksumOriginal":{"type":"string","description":"The MD5 hash value of the original image file"},"hasLinkedVariations":{"type":"integer","description":"Indicates if the item is linked with variations. Returns 1 if at least one variation is linked with the image, otherwise 0."},"size":{"type":"integer","description":"The size of the image in pixels"},"width":{"type":"integer","description":"The width of the image in pixels"},"height":{"type":"integer","description":"The height of the image in pixels"},"url":{"type":"string","description":"The URL under which the image can be accessed after the upload."},"urlMiddle":{"type":"string","description":"The URL that points to the medium-sized version of the item image."},"urlPreview":{"type":"string","description":"The URL that points to the first preview version of the item image."},"urlSecondPreview":{"type":"string","description":"The URL that points to the second preview version of the item image."}}},"ItemImageName":{"type":"object","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"}}},"ItemImageAvailability":{"type":"object","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: <ul><li>mandant = The image can be made available for clients (stores).<\/li><li>marketplace = The image can be made available for markets.<\/li><li>listing = The image can be made available for listings.<\/li><\/ul>"},"value":{"type":"number","description":"For the type <b>mandant<\/b>, this is the plentyID of the client (store) for which the image is available. For the types <b>marketplace<\/b> and <b>listing<\/b>, this is the ID of the referrer for which the image is available. <ul><li><strong>-1.00<\/strong> = The image is available for all referrers of this type.<\/li><\/ul>"}}},"AttributeValueImage":{"type":"object","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"}}},"VariationImage":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the link between a variation and an image"},"itemId":{"type":"integer","description":"The unique ID of the item"},"variationId":{"type":"integer","description":"The unique ID of the variation"},"imageId":{"type":"integer","description":"The unique ID of the image"},"createdAt":{"type":"string","description":"The time the image was linked to the variation."},"updatedAt":{"type":"string","description":"The time the link between an image and a variation was last updated."}}},"ItemCrossSelling":{"type":"object","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:<ul><li>Accessory = The cross-selling item is an accessory of the item.<\/li><li>ReplacementPart = The cross-selling item is a replacement part for the item.<\/li><li>Similar = The cross-selling item is similar to the item.<\/li><li>Bundle = The cross-selling item is suitable to be sold as a bundle with the item.<\/li><\/ul>"},"isDynamic":{"type":"boolean","description":"Flag that indicates if the cross-selling link was generated automatically."}}},"VariationDescription":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the description"},"itemId":{"type":"integer","description":"The unique ID of the item that this description belongs to"},"lang":{"type":"string","description":"The <a href=\"https:\/\/developers.plentymarkets.com\/rest-doc\/introduction#countries\" target=\"_blank\">language code<\/a> 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."},"title":{"type":"string","description":"The html title for webshop of the item. By default, this title is displayed in the online store html. Character limit: max. 240 characters."},"name2":{"type":"string","description":"Alternative item name that can be used e.g. for markets. Character limit: max. 240 characters."},"name3":{"type":"string","description":"Alternative item name that can be used e.g. for markets. Character limit: max. 240 characters."},"previewDescription":{"type":"string","description":"The preview text. The preview text is a short description that can be displayed in item lists."},"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."},"description":{"type":"string","description":"The item description. This is a detailed description displayed in the item layout of the online store."},"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."},"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."},"metaKeywords":{"type":"string","description":"Meta keywords to tag the item for search engines. More than one keyword can be separated by commas."}}},"VariationMarketIdentNumber":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the market ident number (ASIN\/ePID) of a variation"},"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)"},"position":{"type":"integer","description":"The position of the market ident number (ASIN\/ePID)"},"value":{"type":"string","description":"The value of the market ident number (ASIN\/ePID)"}}},"VariationStock":{"type":"object","properties":{"itemId":{"type":"integer","description":"The ID of the item"},"variationId":{"type":"integer","description":"The ID of the variation"},"warehouseId":{"type":"integer","description":"The ID of the warehouse"},"reservedListing":{"type":"number","description":"The quantity of a variation that is reserved for listings"},"reservedBundles":{"type":"number","description":"The quantity of a variation that is reserved for item bundles"},"valueOfGoods":{"type":"number","description":"The value of goods based on the physical stock"},"purchasePrice":{"type":"number","description":"The purchase price of the variation stock"},"physicalStock":{"type":"number","description":"The physical stock of the variation stock"},"reservedStock":{"type":"number","description":"The reserved stock of the variation stock"},"netStock":{"type":"number","description":"The net stock is the stock that can still be sold"},"reorderLevel":{"type":"number","description":"The quantity of a variation that triggers a reorder"},"deltaReorderLevel":{"type":"number","description":"The quantity of a variation that is required to reach the reorder level"}}},"VariationStockMovement":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the stock movement"},"itemId":{"type":"integer","description":"The ID of the item"},"variationId":{"type":"integer","description":"The ID of the variation"},"warehouseId":{"type":"integer","description":"The ID of the warehouse"},"reasonString":{"type":"string","description":"The reason string"},"attributeValues":{"type":"string","description":"The attribute values of a variation"},"processRowId":{"type":"integer","description":"The ID is either the actual ID of an order or of an incoming item data set. Whether it is an order ID or an incoming item data set ID depends on the processRowType."},"quantity":{"type":"integer","description":"The quantity"},"reason":{"type":"integer","description":"The reason for the movement"},"createdAt":{"type":"string","description":"The date and time that the movement was created. This date is in W3C format."},"processRowType":{"type":"integer","description":"The type of the stock movement\n<ul>\n <li>1 = incoming item data set<\/li>\n <li>2 = order<\/li>\n <li>3 = deleted stock movement<\/li>\n <li>4 = new stock intake<\/li>\n<\/ul>"},"bestBeforeDate":{"type":"string","description":"The best before date for the movement"},"batch":{"type":"string","description":"The batch for the movement"},"storageLocationName":{"type":"string","description":"The name of the storage location"},"warehouseName":{"type":"string","description":"The name of the warehouse"},"purchasePrice":{"type":"integer","description":"The purchase price of a variation"},"userId":{"type":"integer","description":"The id of the user. Can be null if the movement was not triggered by an user."}}},"StockStorageLocation":{"type":"object","properties":{"itemId":{"type":"integer","description":"The ID of the item"},"variationId":{"type":"integer","description":"The ID of the variation"},"storageLocationId":{"type":"integer","description":"The ID of the storage location."},"warehouseId":{"type":"integer","description":"The ID of the warehouse that the storage location is in"},"quantity":{"type":"number","description":"The quantity stored at the storage location"},"bestBeforeDate":{"type":"string","description":"The best before date"},"batch":{"type":"string","description":"The batch"},"updatedAt":{"type":"string","description":"The day and time the stock was last updated"}}},"VariationAdditionalSku":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the additional sku"},"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)."},"updatedAt":{"type":"string","description":"The time the SKU was updated (YYYY-MM-DD HH:MM:SS)."}}},"VariationBundle":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the link that marks a variation as a bundle component"},"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"},"lastUpdatedTimestamp":{"type":"string","description":"The time the bundle was last updated."},"createdAt":{"type":"string","description":"The time the bundle was created."}}},"VariationPropertyValue":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the link between the variation and the property value"},"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"},"valueInt":{"type":"integer","description":"The int value of the property value of the variation"},"valueFloat":{"type":"number","description":"The float value of the property value of the variation"},"valueFile":{"type":"string","description":"The file value of the property value of the variation"},"surcharge":{"type":"number","description":"The surcharge of the property value of the variation"}}},"VariationSku":{"type":"object","properties":{"id":{"type":"integer","description":"The row ID of the table plenty_item_variation_market_status"},"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."},"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."},"isActive":{"type":"boolean","description":"Flag that indicates if the item is ready for export (currently not in use)."},"createdAt":{"type":"string","description":"The time the SKU was created (YYYY-MM-DD HH:MM:SS)."},"updatedAt":{"type":"string","description":"The time the SKU was updated (YYYY-MM-DD HH:MM:SS)."},"exportedAt":{"type":"string","description":"The time the variation was last exported (YYYY-MM-DD HH:MM:SS)."},"stockUpdatedAt":{"type":"string","description":""},"deletedAt":{"type":"string","description":"The time the variation was deleted (YYYY-MM-DD HH:MM:SS)."},"status":{"type":"string","description":"The status of the variation after the export. Possible entries are INACTIVE, ERROR, SENT and ACTIVE."},"additionalInformation":{"type":"string","description":"The field that contains additional information."}}},"ImagesRelation":{"type":"object","properties":{}},"ItemImagesRelation":{"type":"object","properties":{}},"Tag":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the tag"},"name":{"type":"string","description":"The backend name of the tag"},"color":{"type":"string","description":"The color for the tag"}}},"PluginTranslation":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the translation"},"pluginSetId":{"type":"integer","description":"The ID of the plugin set"},"pluginName":{"type":"string","description":"The name of the plugin"},"languageCode":{"type":"string","description":"The code of the language"},"fileName":{"type":"string","description":"The file of the key"},"key":{"type":"string","description":"The translation key"},"value":{"type":"string","description":"The translation value"}}},"LegalInformation":{"type":"object","properties":{"plentyId":{"type":"integer","description":"The unique identifier of the plenty client"},"lang":{"type":"string","description":"The language of the legal information text"},"type":{"type":"string","description":"The type of the legal information text. The types available are:\n<ul>\n<li>TermsConditions<\/li>\n<li>CancellationRights<\/li>\n<li>PrivacyPolicy<\/li>\n<li>LegalDisclosure<\/li>\n<li>WithdrawalForm<\/li>\n<\/ul>"},"plainText":{"type":"string","description":"The text value of the legal information text"},"htmlText":{"type":"string","description":"The html value of the legal information text"}}},"PaginatedResult":{"type":"object","properties":{}},"Listing":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the listing."},"itemId":{"type":"integer","description":"The ID of the item."},"typeId":{"type":"integer","description":"The ID of the listing type. Possible types are:\n<ul>\n <li>1 = Auction<\/li>\n <li>2 = Fixed<\/li>\n <li>3 = Shop item<\/li>\n<\/ul>"},"stockDependenceTypeId":{"type":"integer","description":"The ID of the listing stock dependence. Possible stock dependence types are:\n<ul>\n <li>1 = Unlimited with sync<\/li>\n <li>2 = Limited with reservation<\/li>\n <li>3 = Limited without reservation<\/li>\n <li>4 = Unlimited without sync<\/li>\n<\/ul>"},"unitCombinationId":{"type":"integer","description":"The ID of the unit combination."}}},"LayoutTemplate":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the layout template."},"name":{"type":"string","description":"The name of the layout template."},"css":{"type":"string","description":"The css of the layout template."},"htmlStructure":{"type":"string","description":"The html structure of the layout template."},"mainFrame":{"type":"string","description":"The main frame of the layout template."},"additionalContent":{"type":"array","items":{},"description":"The additional content of the layout template."},"appendixType":{"type":"string","description":"The appendix type of the layout template."}}},"ListingMarket":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the listing market."},"listingId":{"type":"integer","description":"The listing ID of the current listing market."},"variationId":{"type":"integer","description":"The variation ID for this listing market."},"referrerId":{"type":"integer","description":"The ID of the referrer."},"credentialsId":{"type":"integer","description":"The credentials ID that this listing market belongs to."},"directoryId":{"type":"integer","description":"The directory ID of the listing market."},"enabled":{"type":"boolean","description":"Indicates if the listing market is enabled."},"duration":{"type":"string","description":"The duration of the listing market."},"verified":{"type":"string","description":"Indicates if the listing market has been verified. Possible values are: 'succeeded', 'failed', 'unknown'."},"quantity":{"type":"integer","description":"The quantity set for this listing market."},"allVariations":{"type":"boolean","description":"Indicates if all variations should be included."},"createdAt":{"type":"string","description":"The date that the listing was created."},"updatedAt":{"type":"string","description":"The date that the listing was last updated."}}},"ListingMarketHistory":{"type":"object","properties":{"id":{"type":"integer","description":"The listing market history ID."},"listingMarketId":{"type":"integer","description":"The listing market ID of the current listing market history."},"referrerId":{"type":"integer","description":"The referrer ID."},"externalId":{"type":"string","description":"The external ID of the listing market history."},"statusId":{"type":"integer","description":"The status ID of the current listing market history. The following properties are available:\n<ul>\n<li>1 = Active<\/li>\n<li>2 = Ended<\/li>\n<li>3 = Relisted<\/li>\n<li>4 = Hidden<\/li>\n<\/ul>"},"quantity":{"type":"integer","description":"The quantity available for sale on the marketplace."},"quantitySold":{"type":"integer","description":"The quantity sold currently on the marketplace."},"quantitySoldDelta":{"type":"integer","description":"The difference between the sold quantity and orders imported for this listing market history."},"quantityRemain":{"type":"integer","description":"The quantity remaining on the marketplace."},"price":{"type":"number","description":"The price offered for this listing market. @see ListingMarketHistoryVariation if the listing market history contains variations."},"currency":{"type":"string","description":"The currency for the price of this listing market."},"sku":{"type":"string","description":"The stock keeping unit of this listing market history."},"createdAt":{"type":"string","description":"The date that the entry was created."},"updatedAt":{"type":"string","description":"The date that the entry was updated last."},"hasStockReservationForEbay":{"type":"boolean","description":"The flag which indicates if we have an active stock reservations for this listing"}}},"ListingMarketDirectory":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the listing market directory."},"name":{"type":"string","description":"The name of the listing market directory."},"parentId":{"type":"integer","description":"The parent ID of the listing market directory."},"level":{"type":"integer","description":"The level of the directory."}}},"ListingMarketItemSpecific":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the item specific."},"listingMarketId":{"type":"integer","description":"The LMID which belongs to the item specific ID."},"name":{"type":"string","description":"The name of the item specific."},"value":{"type":"string","description":"The value of the item specific."}}},"ListingMarketText":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the listing market text."},"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."},"description":{"type":"string","description":"The description of the listing market text."}}},"OptionTemplate":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the option template."},"name":{"type":"string","description":"The name of the option template."},"listing":{"type":"array","items":{},"description":"The listing options of the option template."},"listingMarket":{"type":"array","items":{},"description":"The listing market options of the option template."},"marketOptions":{"type":"array","items":{},"description":"The market options of the option template."}}},"ShippingProfile":{"type":"object","properties":{"id":{"type":"integer","description":"The listing shipping profile ID."},"name":{"type":"string","description":"The listing shipping profile name."},"credentialsId":{"type":"integer","description":"The credentials ID that this listing shipping profile belongs to."},"referrerId":{"type":"integer","description":"The referrer ID."},"createdBy":{"type":"string","description":"Who created the shipping profile. Possible values: 'migration','customer','external'."},"isDefault":{"type":"boolean","description":"Tells if the current listing shipping profile is set as default."},"extendedData":{"type":"array","items":{},"description":"Extended data that defines the current shipping profile."}}},"StockDependenceType":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the listing stock dependence type."},"isErasable":{"type":"integer","description":"Flag that indicates if the type can be deleted."},"position":{"type":"integer","description":"The position for sorting."}}},"ListingType":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the listing type."},"isErasable":{"type":"integer","description":"Flag that indicates if the type can be deleted."},"position":{"type":"integer","description":"The position for sorting."}}},"FulfillmentPolicy":{"type":"object","properties":{"fulfillmentPolicyId":{"type":"string","description":"The ID of the fulfillment policy."},"description":{"type":"string","description":"An optional seller-defined description of the fulfillment policy."},"freightShipping":{"type":"boolean","description":"Set this value to true to indicate the seller offers freight shipping."},"globalShipping":{"type":"boolean","description":"If this value is set to true, it indicates the seller has opted-in to the eBay Global Shipping Program and that they use that service for thier internation shipments."},"localPickup":{"type":"boolean","description":"If this value is set to true, it indicates the seller offers local pickup of their items."},"marketplaceId":{"type":"string","description":"The ID of the eBay marketplace to which this fulfillment policy applies. If this value is not specified, value defaults to the seller's eBay registration site."},"name":{"type":"string","description":"A user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace."},"pickupDropOff":{"type":"boolean","description":"If this value is set to true, it indicates the seller offers the \"Click and Collect\" feature."}}},"ItemSpecific":{"type":"object","properties":{"name":{"type":"string","description":"A recommended Item Specific name."},"minValues":{"type":"integer","description":"Minimum number of values that you can specify for this Item Specific."},"maxValues":{"type":"integer","description":"Maximum number of values that you can specify for this Item Specific."},"selectionMode":{"type":"string","description":"Controls whether you can specify your own name and value in listing requests, or if you need to use a name and\/or value that eBay has defined."},"valueType":{"type":"string","description":"The data type (e.g., date) that eBay expects the value to adhere to in listing requests. Only returned if the data type is not Text. In some cases, more details about the data type are returned in the `valueFormat` field."},"valueFormat":{"type":"string","description":"The format of the data type (e.g., date format) that eBay expects the item specific's value to adhere to in listing requests. A data type identified by the `valueType` field may have different representations, and `valueFormat` specifies the precise format that is required."},"helpText":{"type":"string","description":"Help-text defines the purpose of the Item Specific. The help text will be shown only when it is available for the particular Item Specific."},"helpUrl":{"type":"string","description":"A page on the eBay Web site with context-specific help tips that provide useful information about this Item Specific. Only returned when an applicable page is available in the system."},"variationPicture":{"type":"string","description":"Indicates whether the name (e.g., Color) can (or must) be used to classify the variation pictures"},"variationSpecifics":{"type":"string","description":"Indicates whether the recommended name\/value pair can be used as variation attributes in a fixed-price listing call. For example, a given category could disable a name like Brand in variation specifics (if Brand is only allowed in the item specifics at the Item level). The same category could enable a name like Size for variation specifics (in addition to recommending it for item specifics). If not returned, then the name\/value can be used for both variation specifics and item specifics."},"values":{"type":"array","items":{},"description":"The available values."}}},"Marketplace":{"type":"object","properties":{"siteId":{"type":"integer","description":"The ID of the site exactly as eBay specifies it in the docs. This value is\/was used in the old eBay SOAP APIs"},"marketplaceId":{"type":"string","description":"The ID of the marketplace exactly as eBay specifies it in the docs. This value is used in the new eBay REST APIs. Eg. `EBAY_DE` or `EBAY-DE`"},"marketId":{"type":"integer","description":"System-Listing wide internal ID for the listing marketplace. This id occurs only in correlation with the listing DB tables."},"referrerId":{"type":"number","description":"System wide internal ID for the marketplace. Use this instead of `marketId` whenever possible!"},"shortcut":{"type":"string","description":"The marketplace shortcut name."},"currency":{"type":"string","description":"The currency used for the marketplace"}}},"Fitment":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the fitment."},"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."}}},"FitmentItem":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the item that belongs to the fitment."},"fitmentId":{"type":"integer","description":"The id of the fitment."}}},"PaymentPolicy":{"type":"object","properties":{"paymentPolicyId":{"type":"string","description":"The ID of the payment policy."},"description":{"type":"string","description":"An optional seller-defined description of the payment policy. (Max length: 250)"},"immediatePay":{"type":"boolean","description":"Indicate if the payment is due upon receipt or not. (eBay generates a receipt when the buyer agrees to purchase an item)"},"marketplaceId":{"type":"string","description":"The ID of the eBay marketplace to which this return policy applies. If this value is not specified, value defaults to the seller's eBay registration site."},"name":{"type":"string","description":"A user-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace. (Max length: 64)"},"paymentInstructions":{"type":"string","description":"Allows the seller to give payment instructions to the buyer. These instructions appear on the eBay View Item and Checkout pages."}}},"ReturnPolicy":{"type":"object","properties":{"returnPolicyId":{"type":"string","description":"The ID of the return policy."},"description":{"type":"string","description":"An optional seller-defined description of the return policy."},"extendedHolidayReturnsOffered":{"type":"boolean","description":"If this value is set to true, it indicates the seller offers an Extended Holiday Returns policy for their listings."},"marketplaceId":{"type":"string","description":"The ID of the eBay marketplace to which this return policy applies. If this value is not specified, value defaults to the seller's eBay registration site."},"name":{"type":"string","description":"A user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace."},"refundMethod":{"type":"string","description":"Indicates the method the seller uses to compensate the buyer for returned items. The return method specified applies only to remorse returns. Available options: `MERCHANDISE_CREDIT`, `MONEY_BACK`."},"restockingFeePercentage":{"type":"string","description":"Sellers who accept returns should include this field if they charge buyers a restocking fee when items are returned."},"returnInstruction":{"type":"string","description":"This optional free-form string field lets the seller provide a detailed explanation of the return policy."},"returnInstructions":{"type":"string","description":"This optional free-form string field lets the seller provide a detailed explanation of the return policy."},"returnMethod":{"type":"string","description":"This field indicates the method in which the seller handles non-money back return requests for remorse returns. Sellers can specify they either exchange or replace items. Available options: `EXCHANGE`, `REPLACEMENT`."},"returnsAccepted":{"type":"boolean","description":"Set this value to true to indicate the seller accepts returns."},"returnShippingCostPayer":{"type":"string","description":"The seller uses this value to specify whether the buyer or the seller is responsible for paying return shipping charges. The field can be set to either `BUYER` or `SELLER`."}}},"Settings":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the market settings."},"marketplaceId":{"type":"integer","description":"The ID of the marketplace."},"type":{"type":"string","description":"The type of the current market settings. Possible values are: attribute, attributeValue, property, category, shipping."},"settings":{"type":"array","items":{},"description":"The market settings for the current marketplace."}}},"Message":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID5 identifier of the message"},"plentyIdHash":{"type":"string","description":"The plenty ID hash"},"parentUuid":{"type":"string","description":"The UUID5 of the parent message"},"conversationId":{"type":"string","description":"The UUID5 of the conversation"},"whispered":{"type":"boolean","description":"Whether the message is whispered\n(not visible for the contact\/order linked to the message) or not"},"forwarded":{"type":"boolean","description":"Whether the message is forwarded to another recipient or not"},"tags":{"type":"array","items":{},"description":"An array with tag IDs assigned to the message"},"title":{"type":"string","description":"The title of the message"},"preview":{"type":"string","description":"The first two lines of the message without any markup"},"message":{"type":"string","description":"The content of the message"},"plainMessage":{"type":"string","description":"The content of the message as plain text"},"attachedFilesCount":{"type":"integer","description":"The amount of attached files (readonly)"},"doneAt":{"type":"string","description":"The date the messages was set to done"},"createdAt":{"type":"string","description":"The creation date of the message"},"updatedAt":{"type":"string","description":"The date of the last update of the message"},"deletedAt":{"type":"string","description":"The date the message was deleted"},"deletedBy":{"type":"integer","description":"The ID of the user who deleted the message"},"inboxId":{"type":"string","description":"The inboxId of the message\/conversation"},"categoryId":{"type":"integer","description":"The categoryID of the message\/conversation"},"typeId":{"type":"integer","description":"The typeID of the conversation"},"typePosition":{"type":"integer","description":"The typePosition of the typeID"},"statusId":{"type":"integer","description":"The statusID of the conversation"},"statusPosition":{"type":"integer","description":"The statusPosition of statusID"},"messageType":{"type":"string","description":"The type of message\n(example:{@link MessageTypesService::MESSAGE_TYPE_NEW_MESSAGE_FROM_CONTACT})"},"eventId":{"type":"integer","description":"The ID of the event that created the message"}}},"MessageTo":{"type":"object","properties":{"user":{"type":"array","items":{},"description":"An array with user IDs of users receiving the message"},"role":{"type":"array","items":{},"description":"An array with user role IDs of user roles receiving the message"},"email":{"type":"array","items":{},"description":"An array with emails receiving the message"},"allUsers":{"type":"boolean","description":"Flag indicating that all system users receive the message"},"contacts":{"type":"array","items":{},"description":"A snapshot of the contacts from conversation->conversationRecipients"},"orders":{"type":"array","items":{},"description":"A snapshot of the orders from conversation->conversationRecipients"},"emails":{"type":"array","items":{},"description":"A snapshot of the emails from conversation->conversationRecipients"}}},"MessageLinkedTo":{"type":"object","properties":{"type":{"type":"string","description":"The type of the link (one of {@link MessageTypesService::LINKED_TO_TYPE_MESSAGE},\n{@link MessageTypesService::LINKED_TO_TYPE_ORDER}, {@link MessageTypesService::LINKED_TO_TYPE_CONTACT}\nand {@link MessageTypesService::LINKED_TO_TYPE_PAYMENT})"},"value":{"type":"string","description":"The value of the link. For type {@link MessageTypesService::LINKED_TO_TYPE_MESSAGE} it is a string (uuid5)\nand an integer otherwise."},"typeId":{"type":"string","description":"This can be the ID of a sub-type (e.g. the order subTypeId). (optional)"}}},"MessageMetaData":{"type":"object","properties":{"readBy":{"type":"array","items":{},"description":"The array of users"},"plentyId":{"type":"integer","description":"the plenty id of the related contact"}}},"MessageFrom":{"type":"object","properties":{"type":{"type":"string","description":"The type of the from instance (one of {@link MessageTypesService::FROM_TYPE_USER},\n{@link MessageTypesService::FROM_TYPE_CONTACT} and {@link MessageTypesService::FROM_TYPE_EMAIL})"},"value":{"type":"string","description":"The value of the instance. For type {@link MessageTypesService::FROM_TYPE_EMAIL} it is a string (the email)\nand the id of the user or the contact otherwise."},"name":{"type":"string","description":"An optional name for the instance, e.g. the real name for type {@link MessageTypesService::FROM_TYPE_EMAIL}"}}},"MessageReferrer":{"type":"object","properties":{"type":{"type":"string","description":"The type of the from instance (one of {@link MessageTypesService::REFERRER_TYPE_SYSTEM},\n{@link MessageTypesService::REFERRER_TYPE_BACKEND}, {@link MessageTypesService::REFERRER_TYPE_REST},\n{@link MessageTypesService::REFERRER_TYPE_EMAIL} and {@link MessageTypesService::REFERRER_TYPE_PLUGIN})"},"value":{"type":"string","description":"The value of the instance. It is an integer (the user id) for type\n{@link MessageTypesService::REFERRER_TYPE_SYSTEM}, {@link MessageTypesService::REFERRER_TYPE_EMAIL}, {@link MessageTypesService::REFERRER_TYPE_BACKEND}\nand {@link MessageTypesService::REFERRER_TYPE_REST} and a string (the plugin name) for type\n{@link MessageTypesService::REFERRER_TYPE_PLUGIN}."},"name":{"type":"string","description":"An optional name for the instance. For type {@link MessageTypesService::REFERRER_TYPE_PLUGIN} it is\nthe plugin namespace, the user name otherwise."}}},"Attachment":{"type":"object","properties":{"name":{"type":"string","description":"The file name of the attachment"},"message":{"type":"string","description":"The UUID of the message the attachment belongs to"},"size":{"type":"integer","description":"The size of the attachment in bytes"},"contentType":{"type":"string","description":"The content type fo the attachment"},"content":{"type":"string","description":"The content of the attachment"},"createdAt":{"type":"string","description":"The createdAt date of the attachment"}}},"ConversationSettings":{"type":"object","properties":{}},"Entry":{"type":"object","properties":{"subject":{"type":"string","description":"The subject of the newsletter entry"},"body":{"type":"string","description":"The body of the newsletter entry"},"kind":{"type":"string","description":"The type of the newsletter entry"}}},"Folder":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the newsletter folder"},"name":{"type":"string","description":"The name of the newsletter folder"},"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."},"position":{"type":"integer","description":"The position of the newsletter folder"},"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."}}},"Recipient":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the newsletter recipient"},"folderId":{"type":"integer","description":"The ID of the newsletter folder"},"contactId":{"type":"integer","description":"The ID of the contact"},"firstName":{"type":"string","description":"The first name of the recipient"},"lastName":{"type":"string","description":"The last name of the recipient"},"email":{"type":"string","description":"The email address of the recipient"},"gender":{"type":"string","description":"The gender of the recipient"},"birthday":{"type":"string","description":"The birthday of the recipient"},"timestamp":{"type":"integer","description":"The timestamp when the newsletter email was sent to the recipient"},"templateLang":{"type":"string","description":"The language of the newsletter email template"},"confirmedTimestamp":{"type":"integer","description":"The timestamp when the recipient confirmed the newsletter subscription"},"confirmAuthString":{"type":"string","description":"The key that is automatically generated by the system. This key recognises the user regardless whether the user is logged in to the system and will then set the confirmation timestamp."},"confirmationURL":{"type":"string","description":"The url with which the customer has confirmed the newsletter"}}},"AddressOrderRelation":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the address order relation"},"orderId":{"type":"integer","description":"The ID of the order"},"typeId":{"type":"integer","description":"The ID of the address type\n<ul>\n <li>Billing address = 1<\/li>\n <li>Delivery address = 2<\/li>\n <li>Sender address = 3<\/li>\n <li>Return address = 4<\/li>\n <li>Client address = 5<\/li>\n <li>Contractor address = 6<\/li>\n <li>Warehouse address = 7<\/li>\n <\/ul>"},"addressId":{"type":"integer","description":"The ID of the address"}}},"CouponCampaign":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of a coupon campaign"},"externalId":{"type":"string","description":"DEPRECATED! The external ID of a coupon campaign"},"name":{"type":"string","description":"The name of the coupon campaign"},"variable":{"type":"integer","description":"The variable to display coupon codes in emails. There are only 10 variables available. A variable may only be used for one campaign. The variable names follow this pattern: CouponCode + Number e.g. CouponCode1."},"isPermittedForExternalReferrers":{"type":"boolean","description":"Flag that indicates whether or not coupons can be redeemed if a customer enters the online store from an external referrer.\n<ul><li>TRUE = The coupon can be redeemed if the customer enters the online store from an external referrer\u2028<\/li>\n<li>FALSE = The coupon can not be redeemed<\/li><\/ul>"},"includeShipping":{"type":"boolean","description":"The discount also applies to shipping costs. The property will be only be set if the discount type fixed is set."},"unusedCodesCount":{"type":"integer","description":"The number of codes that have been redeemed"},"usedCodesCount":{"type":"integer","description":"The number of codes that have not been redeemed"},"endsAt":{"type":"string","description":"The date that the campaign ends"},"startsAt":{"type":"string","description":"The date that the campaign starts"},"minOrderValue":{"type":"number","description":"The minimum order value that needs to be reached for the coupon to be redeemed. If the value is not reached the coupon will not be redeemed."},"codeDurationWeeks":{"type":"integer","description":"The number of weeks that codes of this campaign can be redeemed after they have been generated."},"codeAssignment":{"type":"string","description":"The code assignment is only relevant for vouchers. Codes can either be generated every time a voucher is bought or a code from a previously created list of codes can be used. The three options available are generate, use_existing and only_use_existing.\n<ul><li>generate = a new code is generated on demand<\/li>\n<li>use_existing = the code already exists and is taken from a previously entered list of codes, in case of vouchers a new code will be generated for each item purchased that has associated a campaign ID<\/li>\n<li>only_use_existing = the code already exists and is taken from a previously entered list of codes, for vouchers no additional code will be generated for items purchased, only existing codes will be used<\/li><\/ul>"},"codeLength":{"type":"string","description":"There are 3 different length available. The code can be 6, 16, 24 or 32 characters long."},"usage":{"type":"string","description":"The usage defines what the coupon codes from this campaign can be used for. There are three options available:\n<ul><li>single_and_subscription = The codes can be used for single orders and subscription orders<\/li>\n<li>single_order = The codes can be used for single orders only<\/li>\n<li>subscription = The codes can be used for subscriptions only<\/li><\/ul>"},"concept":{"type":"string","description":"The campaign concept defines how many codes belong to a campaign. The concept interacts with the redeem type that is explained next. There are two concept options available:\n<ul><li>single_code = The campaign has only one code<\/li>\n<li>multi_code = The campaign has several codes<\/li><\/ul>"},"redeemType":{"type":"string","description":"The redeem type defines how many times a code of a campaign can be redeemed. There are 4 redeem types available:\n<ul><li>multi_redeem_per_user = Each customer is allowed to redeem the same code several times<\/li>\n<li>single_redeem_per_user = Each customer can only redeem the same code once<\/li>\n<li>redeem_until_value_reached = A code can be entered several times by the same customer or by different customers, but only until the coupon value is depleted<\/li>\n<li>unique_redeem = The code can be redeemed once. If several customers get the same code, only the first customer to enter the code can use it.<\/li><\/ul>\nThe redeem type interacts with the concept. Pay attention to the combination these two options form."},"discountType":{"type":"string","description":"There are 4 discount types available:\n<ul><li>fixed = The coupon value is a fixed amount of money. This discount type is the only one that makes sense for coupons that are sold in the online store. The actual amount of money needs to be set with the value property.<\/li>\n<li>percent = The discount is given as percentage and the actual value depends on the purchase. The actual number of percent need to be set with the value property.<\/li>\n<li>item = The discount applies to entire items. A typical example would be - Buy 1 get 1 free - or in other words - Get 2 for the price of 1. The number of items the customer gets and the number of items the customer has to pay for need to be set with itemDiscountToPay and itemDiscountToBuy.<\/li>\n<li>shipping = The shipping does not cost anything. The cost will be set to zero no matter what the actual shipping costs are.<\/li><\/ul>"},"itemDiscountToPay":{"type":"integer","description":"The number of items that the customer has to pay for. This number needs to be compared to the number of items the customer receives, itemDiscountToBuy"},"itemDiscountToBuy":{"type":"integer","description":"The number of items that the customer receives, but he or she only has to pay for the number of items set with itemDiscountToPay."},"campaignType":{"type":"string","description":"The two campaign types available are coupon or voucher."},"couponType":{"type":"string","description":"The coupon type is only for campaigns that have the campaign type coupon. The two coupon types available are promotion and sales."},"description":{"type":"string","description":"The description of the campaign"},"value":{"type":"number","description":"The actual discount value of a coupon. The value needs to be set for the two discount types fixed and percent."}}},"CouponCampaignCode":{"type":"object","properties":{"code":{"type":"string","description":"The coupon code"},"campaignId":{"type":"integer","description":"The ID of the campaign that the code belongs to"},"disable":{"type":"integer","description":"Flag that indicates if a code is active or deactivated.\n<ul><li>True = the code is deactivated<\/li>\n <li>False = the code is active<\/li><\/ul>"},"consumed":{"type":"integer","description":"Flag that indicates if a code was redeemed or not.\n<ul><li>True = the code was redeemed<\/li>\n <li>False = the code is not redeemed<\/li><\/ul>"},"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."},"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."}}},"CouponCodeValidation":{"type":"object","properties":{"campaignId":{"type":"integer","description":"The ID of the campaign"},"validationType":{"type":"string","description":"The type of the campaign. Currently the only type available is plentymarkets."},"contactId":{"type":"integer","description":"The ID of the contact that wants to redeem the coupon"},"couponCode":{"type":"string","description":"The coupon code"},"currency":{"type":"string","description":"The currency of the purchase"},"exchangeRate":{"type":"number","description":"The exchange rate of the purchase (optional, is loaded from settings if not given)"},"referrer":{"type":"number","description":"The order referrer"},"salesDiscount":{"type":"number","description":"The total discount from a coupon applied to an order. The discount is given as gross amount."},"salesDiscountNet":{"type":"number","description":"The net discount from a coupon applied to an order. The net discount is the total discount minus the vat amount."},"itemDiscount":{"type":"number","description":"The discount amount applied to items."},"itemDiscountNet":{"type":"number","description":"The net discount applied to items."},"shippingDiscount":{"type":"number","description":"The discount applied to shipping costs."},"shippingDiscountNet":{"type":"number","description":"The net discount applied to shipping costs."},"usedVatFields":{"type":"array","items":{},"description":"The vat fields used for the validation"},"restCouponAmount":{"type":"number","description":"The remaining coupon amount"},"checkedItems":{"type":"array","items":{},"description":"The list of variations that passed the validation"},"validateParams":{"type":"array","items":{},"description":"Validation parameters"},"couponCampaignType":{"type":"string","description":"The campaign type"}}},"CouponCodeContact":{"type":"object","properties":{"code":{"type":"string","description":"The coupon code"},"contactId":{"type":"integer","description":"The ID of the contact that redeemed the coupon"},"openAmount":{"type":"number","description":"The coupon amount that can still be redeemed"},"redeemCount":{"type":"integer","description":"How many times a coupon code has already been redeemed"},"updatedAt":{"type":"string","description":"The date that the coupon code was updated last."},"campaignId":{"type":"integer","description":"The ID of the campaign that the coupon belongs to"},"externalTransactionId":{"type":"integer","description":"The ID that is assigned to a coupon by the external coupon service provider, when the coupon is redeemed."}}},"Currency":{"type":"object","properties":{"currency":{"type":"string","description":"The ISO 4217 code and id of the currency."},"htmlCode":{"type":"string","description":"The html code (entity) for the currency."},"unicodeSign":{"type":"string","description":"The unicode symbol for the currency. If no unicode symbol exists, the html code will be used."},"isActive":{"type":"boolean","description":"Flag that indicates if the currency is active in the system or not. Currencies are activated per sales price."},"isErasable":{"type":"boolean","description":"Flag that indicates if this currency can be deleted or not. <ul><li>False = Currency cannot be deleted<\/li><li>True = Currency can be deleted<\/li><\/ul>"},"exchangeRate":{"type":"number","description":"The current exchange rate for this currency."}}},"LiveExchangeRatesResult":{"type":"object","properties":{"baseCurrency":{"type":"string","description":"The base currency"},"exchangeRates":{"type":"array","items":{},"description":"The exchange rates"}}},"Country":{"type":"object","properties":{"id":{"type":"integer","description":"The country id."},"name":{"type":"string","description":"The system country name."},"shippingDestinationId":{"type":"integer","description":"The shipping destination (region) id."},"active":{"type":"integer","description":"The active flag (1: active, 2: backend active, 3: supplier active"},"storehouseId":{"type":"integer","description":"The id of the main warehouse in this country."},"isoCode2":{"type":"string","description":"The ISO 3166 ALPHA-2 code of the country."},"isoCode3":{"type":"string","description":"The ISO 3166 ALPHA-3 code of the country."},"lang":{"type":"string","description":"The main language spoken in the country."},"isCountryStateMandatory":{"type":"boolean","description":"Flag that states if a country state is mandatory for the country."},"vatCodes":{"type":"array","items":{},"description":"An array with country vat codes."}}},"CurrencyExchangeRate":{"type":"object","properties":{"exchangeRate":{"type":"number","description":"The exchange rate"}}},"OrderDateType":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the order date type. The following date types are available:\n\n* Deleted on = 1\n* Created on = 2\n* Paid date = 3\n* Last update = 4\n* Completed on = 5\n* Return date = 6\n* Payment due date = 7\n* Estimated shipping date = 8\n* Start date = 9\n* End date = 10\n* Possible delivery date = 11\n* Market transfer date = 12\n* Subscription cancelled on = 13\n* Subscription last run = 14\n* Subscription next run = 15\n* Confirmation link valid until = 19"},"isErasable":{"type":"boolean","description":"Flag that indicates if this type can be deleted or not."},"position":{"type":"integer","description":"The position for sorting"}}},"OrderDateTypeName":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the order date type name"},"typeId":{"type":"integer","description":"The ID of the date type that this name belongs to. The following date types are available:\n\n* Deleted on = 1\n* Created on = 2\n* Paid date = 3\n* Last update = 4\n* Completed on = 5\n* Return date = 6\n* Payment due date = 7\n* Estimated shipping date = 8\n* Start date = 9\n* End date = 10\n* Possible delivery date = 11\n* Market transfer date = 12"},"lang":{"type":"string","description":"The ISO 639-1 language code for the name, e.g. \"en\" for English"},"name":{"type":"string","description":"The name of the order date type"}}},"OrderItemDate":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the order date"},"orderItemId":{"type":"integer","description":"The ID of the order item that the date belongs to"},"typeId":{"type":"integer","description":"The ID of the date type. The following types are available:\n\n* Start date = 9\n* End date = 10\n* Estimated delivery date = 11"},"createdAt":{"type":"string","description":"The date when the date was created"},"updatedAt":{"type":"string","description":"The date when the date was last updated"}}},"OrderItemProperty":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the order item property."},"orderItemId":{"type":"integer","description":"The ID of the order item that the property belongs to."},"typeId":{"type":"integer","description":"The ID of the property type.\n\n* WAREHOUSE = 1\n* SHIPPING_PROFILE = 2\n* PAYMENT_METHOD = 3\n* WEIGHT = 11\n* WIDTH = 12\n* LENGTH = 13\n* HEIGHT = 14\n* EXTERNAL_TOKEN_ID = 16\n* EXTERNAL_ITEM_ID = 17\n* COUPON_CODE = 18\n* COUPON_TYPE = 19\n* ORIGINAL_WAREHOUSE = 20\n* ORIGINAL_QUANTITY = 21\n* CATEGORY_ID = 22\n* MARKET_FEE = 23\n* STOCK_REVERSING = 24\n* DISPUTE_STATUS = 25\n* NO_CHANGE_BY_CONTACT = 26\n* SIZE = 29\n* LOCATION_RESERVED = 30\n* EXTERNAL_SHIPMENT_ITEM_ID = 31\n* PARTIAL_SHIPPING_COSTS = 32\n* MAIN_DOCUMENT_NUMBER = 33\n* SALES_TAX_ID_NUMBER = 34\n* RETURNS_REASON = 35\n* RETURNS_ITEM_STATUS = 36\n* FULFILLMENT_CENTER_ID = 37\n* FULFILLMENT_CENTER_COUNTRY_ISO = 38\n* REORDER_ITEM_ID = 39\n* LISTING_TYPE = 40\n* SOLD_COUPON_CODE = 46\n* ORDER_ITEM_STATE = 48\n* SAP_ORDER_NUMBER = 50\n* DISCOUNT = 52\n* REORDER_ITEM_PACKAGE_UNIT = 53\n* REORDER_ITEM_MINIMUM_PURCHASE = 54\n* REORDER_ITEM_DELIVERY_TIME_IN_DAYS = 55\n* REORDER_ITEM_DISCOUNTABLE = 56\n* RETURNS_REMAINING_PERCENTAGE = 57\n* ORDER_PROPERTY_ID = 81\n* ORDER_PROPERTY_VALUE = 82\n* ORDER_PROPERTY_GROUP_ID = 83\n* WEEE_PICK_UP = 92"},"value":{"type":"string","description":"The value of the property. The value depends on type."},"createdAt":{"type":"string","description":"The date that the property was created."},"updatedAt":{"type":"string","description":"The date that the property was last updated."}}},"OrderItemTransaction":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the transaction"},"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'."},"status":{"type":"string","description":"The status. Possible values are 'regular' and '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"},"deliveryNoteNumber":{"type":"string","description":"The delivery note number"},"batchBestBeforeDateId":{"type":"integer","description":"Deprecated. Replaced by $batch and $bestBeforeDate."},"createdAt":{"type":"string","description":"The date the transaction was created"},"updatedAt":{"type":"string","description":"The date the transaction was last updated"}}},"OrderBooking":{"type":"object","properties":{}},"OrderPropertyType":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property type"},"isErasable":{"type":"boolean","description":"Flag that states if this type can be deleted or not."},"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* string\n* int\n* numeric\n* bool\n* enum(val1,val2,val3,...)"}}},"OrderPropertyTypeName":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of type name"},"typeId":{"type":"integer","description":"The ID of the property type"},"name":{"type":"string","description":"The name of property type"},"lang":{"type":"string","description":"The language of the type name"}}},"OrderProperty":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the order property"},"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 = 1\n* SHIPPING_PROFILE = 2\n* PAYMENT_METHOD = 3\n* PAYMENT_STATUS = 4\n* EXTERNAL_SHIPPING_PROFILE = 5\n* DOCUMENT_LANGUAGE = 6\n* EXTERNAL_ORDER_ID = 7\n* CUSTOMER_SIGN = 8\n* DUNNING_LEVEL = 9\n* SELLER_ACCOUNT = 10\n* WEIGHT = 11\n* WIDTH = 12\n* LENGTH = 13\n* HEIGHT = 14\n* FLAG = 15\n* EXTERNAL_TOKEN_ID = 16\n* EXTERNAL_ITEM_ID = 17\n* COUPON_CODE = 18\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* MARKET_TAX_ID = 88\n* MARKET_EORI = 89\n* IS_REVERSE_CHARGED = 90\n* DISALLOW_INTERNAL_TAX_RELEVANT_DOCUMENTS = 91\n* EBAY_PLUS = 994\n* FULFILLMENT_SERVICE = 995"},"value":{"type":"string","description":"The value of the property. The value depends on the type."}}},"OrderReferrer":{"type":"object","properties":{"id":{"type":"number","description":"The ID of the order referrer"},"isEditable":{"type":"boolean","description":"Flag that indicates if this referrer can be updated as well as deleted or not\n<ul><li>True = the referrer can be edited and deleted<\/li>\n<li>False = the referrer can neither be edited nor deleted<\/li><\/ul>"},"backendName":{"type":"string","description":"The backend name of the referrer"},"name":{"type":"string","description":"The public name of the referrer as it is displayed e.g. on documents"},"orderOwnerId":{"type":"integer","description":"The user ID of whoever owns new orders from this referrer"},"isFilterable":{"type":"boolean","description":"Flag that indicates if this referrer can be used as a filter or not\n<ul><li>True = Can be used as a filter<\/li>\n<li>False = Cannot be used as a filter<\/li><\/ul>"},"origin":{"type":"string","description":"The origin of this referrer"},"showInLeads":{"type":"boolean","description":"Referrer is showed in list when creating a new lead"}}},"ExportDocument":{"type":"object","properties":{"id":{"type":"integer","description":""},"orderId":{"type":"integer","description":""},"packageNumber":{"type":"integer","description":""},"base64Content":{"type":"integer","description":""}}},"ShippingPackageType":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the shipping package type"},"name":{"type":"string","description":"The name of the shipping package type"},"width":{"type":"integer","description":"The width of the shipping package type"},"individualWeight":{"type":"integer","description":"The individual weight of the shipping package type"},"height":{"type":"integer","description":"The height of the shipping package type"},"length":{"type":"integer","description":"The length of the shipping package type"},"unit":{"type":"string","description":"The unit of the shipping package type dimension"},"maxWeight":{"type":"integer","description":"The maximum weight of the shipping package type"},"maxVolume":{"type":"integer","description":"The maximum volume of the shipping package type"},"volumeType":{"type":"integer","description":"The volume type of the shipping package type"}}},"OrderShippingPackage":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the order shipping package"},"orderId":{"type":"integer","description":"The ID of the order"},"packageId":{"type":"integer","description":"The ID of the package"},"weight":{"type":"integer","description":"The weight of the package in grams"},"extraWeight":{"type":"integer","description":"The extra weight of the package in grams"},"itemsWeight":{"type":"integer","description":"The items weight of the package in grams"},"packageNumber":{"type":"string","description":"The package number"},"labelPath":{"type":"string","description":"The path to the label"},"labelBase64":{"type":"string","description":"The base64 encoded label"},"exportLabelBase64":{"type":"string","description":"The base64 encoded export label"},"returnPackageNumber":{"type":"string","description":"The return package number"},"packageType":{"type":"integer","description":"The type of the package. The following types are valid:\n<ul>\n <li>0: unpacked<\/li>\n <li>1: Bale<\/li>\n <li>2: Dispenser<\/li>\n <li>3: Coil<\/li>\n <li>4: Roll pallet<\/li>\n <li>5: Colli<\/li>\n <li>6: Container<\/li>\n <li>7: Bucket<\/li>\n <li>8: Cask<\/li>\n <li>9: Bottles<\/li>\n <li>10: European flat pallet<\/li>\n <li>11: Structural frame<\/li>\n <li>12: Gas cylinder<\/li>\n <li>13: Pallet cage<\/li>\n <li>14: Hobbock<\/li>\n <li>15: Half pallet<\/li>\n <li>16: Pallet of food items<\/li>\n <li>17: Wooden coaster<\/li>\n <li>18: IBC container<\/li>\n <li>19: Pitcher<\/li>\n <li>20: Wicker bottle<\/li>\n <li>21: Case<\/li>\n <li>22: Canister<\/li>\n <li>23: Customer pallet<\/li>\n <li>24: Cardboard box<\/li>\n <li>25: Composite packaging<\/li>\n <li>26: Package<\/li>\n <li>27: Ring<\/li>\n <li>28: Role<\/li>\n <li>29: Sack<\/li>\n <li>30: units<\/li>\n <li>31: Tank<\/li>\n <li>32: Drum<\/li>\n <li>34: Crate<\/li>\n <li>35: Quarter pallet<\/li>\n <li>36: Other pallets<\/li>\n <li>37: Bin<\/li>\n <li>38: One-way pallet<\/li>\n <li>39: Foil bag<\/li>\n<\/ul>"},"volume":{"type":"number","description":"The volume of the package"},"palletId":{"type":"integer","description":"The id of the pallet of which the package belong to"},"isClosed":{"type":"boolean","description":"Flag to say if the package is editable or not"},"createdAt":{"type":"string","description":""},"updatedAt":{"type":"string","description":""},"packageSscc":{"type":"string","description":"Amazon Vendor PackageSscc"},"mrn":{"type":"string","description":"Movement Reference Number (MRN)"},"atlasRegistration":{"type":"integer","description":"ATLAS export declaration"}}},"OrderShippingPackageItems":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the order shipping package item. Primary key auto-increment"},"packageId":{"type":"integer","description":"The ID of the package (id column from plenty_package_type2order)"},"itemId":{"type":"integer","description":"The ID of the item (plenty_item_variation_base_item_id column from plenty_item_variation_base)"},"variationId":{"type":"integer","description":"The ID of the variation (plenty_item_variation_base_id column from plenty_item_variation_base)"},"itemQuantity":{"type":"number","description":"The quantity of the item in the package"}}},"OrderShippingPallet":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the order shipping pallet"},"weight":{"type":"number","description":"The weight of the order shipping pallet, including it's contents"},"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"},"additionalInfo":{"type":"integer","description":"Additional info"},"barcode":{"type":"string","description":"The barcode"},"isClosed":{"type":"boolean","description":"Flag to tell if the pallet is closed or not. If true, the information within the pallet should not be changed anymore"},"palletSscc":{"type":"string","description":"Amazon Vendor PalletSscc"},"orderId":{"type":"integer","description":"The id of the order"}}},"ParcelServiceRegion":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the parcel service region"},"shippingRegionId":{"type":"integer","description":"The ID of the shipping region"},"parcelServicePresetId":{"type":"integer","description":"The ID of the parcel service preset"},"shippingRegionName":{"type":"string","description":"The name of the shipping region"},"serviceType":{"type":"integer","description":"Type of the parcel service"}}},"ParcelServicePreset":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the shipping profile (autoincrement value)"},"parcelServiceId":{"type":"integer","description":"The ID of the shipping service provider"},"backendName":{"type":"string","description":"The back end name of the shipping profile"},"flag":{"type":"integer","description":"The icon of the shipping profile"},"priority":{"type":"integer","description":"The priority of the shipping profile"},"category":{"type":"integer","description":"The category of the shipping profile"},"useArticlePorto":{"type":"integer","description":"Flag that indicates if the extra shipping charge saved in the item data record is used"},"isInsured":{"type":"integer","description":"Flag that indicates if the shipping profile is insured"},"isExpress":{"type":"integer","description":"Flag that indicates if the shipping profile is used for express delivery"},"isPostident":{"type":"integer","description":"Flag that indicates if the shipping profile includes an authority verification"},"isDefaultEnabled":{"type":"integer","description":"Flag that indicates if the shipping profile is automatically assigned to new items"},"islandFee":{"type":"number","description":"The extra charge for islands saved in the shipping profile"},"isCod":{"type":"integer","description":"Flag that indicates Cash on Delivery"},"supportedMultishop":{"type":"array","items":{},"description":"The clients (stores) that are activated for the shipping profile"},"supportedReferrer":{"type":"array","items":{},"description":"The order referrers that are activated for the shipping profile"},"subreferrerSupport":{"type":"array","items":{},"description":"This field is currently without any function."},"excludedPaymentMethods":{"type":"array","items":{},"description":"The blocked payment methods that are not offered for the shipping profile"},"excludedCustomerGroups":{"type":"array","items":{},"description":"The blocked customer groups for the shipping profile. Blocked customer groups cannot select the shipping profile during checkout."},"shippingGroup":{"type":"string","description":"The group of the shipping profile"},"dispatchIdentifier":{"type":"string","description":"This field is currently without any function."},"auctionType":{"type":"integer","description":"The eBay listing type for the shipping profile"},"supportedLoyaltyPrograms":{"type":"array","items":{},"description":"The loyalty programs that are supported by the shipping profile"},"updatedAt":{"type":"string","description":"The date the shipping profile was last updated"},"showDataPrivacyAgreementHint":{"type":"integer","description":""},"transmitPrivacyRule":{"type":"string","description":""},"alternativeEmail":{"type":"string","description":""},"alternativePhone":{"type":"string","description":""},"isParcelBox":{"type":"integer","description":"Indicates whether the e.g. paketshop is supported"},"isPostOffice":{"type":"integer","description":"Indicates whether the e.g. postfiliale is supported"},"isSelfPickup":{"type":"integer","description":""}}},"ReturnsServiceProvider":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the returns service provider"},"name":{"type":"string","description":"The name of the returns service provider"},"pluginId":{"type":"integer","description":"The optional ID of the plugin when the returns service provider is registered as a plugin"},"createdAt":{"type":"string","description":"The time the returns service provider was created"},"updatedAt":{"type":"string","description":"The time the returns service provider was updated"}}},"OrderReturns":{"type":"object","properties":{"id":{"type":"integer","description":""},"orderId":{"type":"integer","description":""},"returnsOrderId":{"type":"integer","description":""},"providerId":{"type":"integer","description":""},"fileName":{"type":"string","description":""},"externalNumber":{"type":"string","description":""},"externalData":{"type":"string","description":""}}},"ShippingInformation":{"type":"object","properties":{"orderId":{"type":"integer","description":"The ID of the order"},"shippingServiceProvider":{"type":"string","description":"The name of the shipping service provider"},"transactionId":{"type":"string","description":"The ID of the transaction"},"shippingStatus":{"type":"string","description":"The shipping status. Possible values are 'open', 'prepared' and 'registered'."},"shippingCosts":{"type":"number","description":"The shipping costs"},"additionalData":{"type":"string","description":"The additional data. Depending on the shipping service provider selected, this data may contain different information, e.g. shipping service, email address and order ID."},"registrationAt":{"type":"integer","description":"The date and time the shipment was registered"},"shipmentAt":{"type":"integer","description":"The date the items will be shipped"}}},"ShippingServiceProvider":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the shipping service provider"},"name":{"type":"string","description":"The name of the shipping service provider"},"pluginId":{"type":"integer","description":"The optional ID of the plugin when the shipping service provider is registered as a plugin"},"icon":{"type":"string","description":"The optional path of the icon"},"createdAt":{"type":"string","description":"The time the shipping service provider was created"},"updatedAt":{"type":"string","description":"The time the shipping service provider was updated"}}},"StatusHistoryEntry":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the status history entry"},"orderId":{"type":"integer","description":"The ID of the order"},"statusId":{"type":"number","description":"The ID of the status"},"createdAt":{"type":"string","description":"The date when the entry was created"},"userId":{"type":"integer","description":"The ID of the user"},"procedureText":{"type":"string","description":"The information text of the procedure that created the entry"}}},"OrderStatus":{"type":"object","properties":{"statusId":{"type":"number","description":"The ID of the status."},"isErasable":{"type":"boolean","description":"Flag that indicates whether the status is erasable or not."},"createdAt":{"type":"string","description":"The date, when the status was created."},"updatedAt":{"type":"string","description":"The date, when the status was updated."},"isFrontendVisible":{"type":"boolean","description":"Indicates visibility in frontend."},"isReorderVisible":{"type":"boolean","description":"Indicates visibility in reorder."},"isRedistributionVisible":{"type":"boolean","description":"Indicates visibility in redistribution."},"color":{"type":"string","description":"The color of the status."}}},"ContactWish":{"type":"object","properties":{"text":{"type":"string","description":"The text of the contact wish"}}},"OrderDate":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the order date"},"orderId":{"type":"integer","description":"The ID of the order that the date belongs to"},"typeId":{"type":"integer","description":"The ID of the date type. The following types are available:\n\n* Deleted on = 1\n* Created on = 2\n* Paid date = 3\n* Last update = 4\n* Completed date = 5\n* Return date = 6\n* Payment due date = 7\n* Estimated shipping date = 8\n* Start date = 9\n* End date = 10\n* Estimated delivery date = 11\n* Market transfer date = 12\n* Subscription cancelled on = 13\n* Subscription last run = 14\n* Subscription next run = 15\n* Purchase date = 16\n* Finish date = 17"},"createdAt":{"type":"string","description":"The date when the date was created"},"updatedAt":{"type":"string","description":"The date when the date was last updated"}}},"DocumentData":{"type":"object","properties":{"content":{"type":"string","description":"The base64 encoded file data."},"type":{"type":"string","description":"The type of the document."},"number":{"type":"integer","description":"The document number"},"numberWithPrefix":{"type":"string","description":"The document number with prefix"},"directoryId":{"type":"integer","description":"The ID of the directory"},"path":{"type":"string","description":"The path"},"userId":{"type":"integer","description":"The ID of the user"},"source":{"type":"string","description":"The source"},"displayDate":{"type":"string","description":"The date displayed on the document"}}},"OrderFamily":{"type":"object","properties":{"originOrderId":{"type":"integer","description":""},"mainSalesOrderId":{"type":"integer","description":""}}},"OrderItem":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the order item"},"orderId":{"type":"integer","description":"The ID of the order that the order item belongs to"},"typeId":{"type":"integer","description":"The ID of the order item type\n\n* VARIATION = 1\n* ITEM_BUNDLE = 2\n* BUNDLE_COMPONENT = 3\n* PROMOTIONAL_COUPON = 4\n* GIFT_CARD = 5\n* SHIPPING_COSTS = 6\n* PAYMENT_SURCHARGE = 7\n* GIFT_WRAP = 8\n* UNASSIGEND_VARIATION = 9\n* DEPOSIT = 10\n* ORDER = 11\n* DUNNING_CHARGE = 12\n* ITEM_SET = 13\n* SET_COMPONENT = 14\n* ORDER_PROPERTY = 15"},"referrerId":{"type":"number","description":"The ID of order item referrer"},"itemVariationId":{"type":"integer","description":"The ID of the item variation"},"quantity":{"type":"number","description":"The quantity."},"orderItemName":{"type":"string","description":"The name of the order item"},"attributeValues":{"type":"string","description":"The attribute value names"},"shippingProfileId":{"type":"integer","description":"The ID of the order item's shipping profile"},"countryVatId":{"type":"integer","description":"The ID of the country vat"},"vatField":{"type":"integer","description":"The vat id (0-5)."},"vatRate":{"type":"number","description":"The vat amount, e.g. 19.0 for 19% VAT."},"position":{"type":"integer","description":"The order items position in the order."},"warehouseId":{"type":"integer","description":"The ID of the warehouse."},"createdAt":{"type":"string","description":"The date at which the order item was created."},"updatedAt":{"type":"string","description":"The date that the order item was last updated."}}},"OrderSerialNumber":{"type":"object","properties":{"serialNumberId":{"type":"integer","description":"The ID of the serial number"},"orderId":{"type":"integer","description":"The ID of the order"},"orderItemId":{"type":"integer","description":"The ID of the order item"},"serialNumber":{"type":"string","description":"The serial number"}}},"PaymentPropertyTypeName":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the name of the property type"},"typeId":{"type":"integer","description":"The ID of the property type"},"lang":{"type":"string","description":"The language of the name of the property type"},"name":{"type":"string","description":"The name of the property type"}}},"PaymentContactRelation":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the payment order relation"},"paymentId":{"type":"integer","description":"The ID of the payment"},"contactId":{"type":"integer","description":"The ID of the contact"},"assignedAt":{"type":"string","description":"The time the payment contact relation was assigned"}}},"PaymentOrderRelation":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the payment order relation"},"paymentId":{"type":"integer","description":"The ID of the payment"},"orderId":{"type":"integer","description":"The ID of the order"},"assignedAt":{"type":"string","description":"The time the payment order relation was assigned"}}},"Payment":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the payment"},"amount":{"type":"number","description":"The amount of the payment"},"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."},"parentId":{"type":"integer","description":"The ID of the parent payment"},"deleted":{"type":"integer","description":"A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end."},"unaccountable":{"type":"integer","description":"An unassigned payment. Unassigned payments have the value 1."},"currency":{"type":"string","description":"The currency of the payment in ISO 4217 code."},"type":{"type":"string","description":"The payment type. Available types are credit and debit."},"hash":{"type":"string","description":"The hash code of the payment. The hash code consists of 32 characters and is automatically generated."},"origin":{"type":"integer","description":"The origin of the payment. The following origins are available:\n<ul>\n <li>Undefined = 0<\/li>\n <li>System = 1<\/li>\n <li>Manually = 2<\/li>\n <li>SOAP = 3<\/li>\n <li>Import = 4<\/li>\n <li>Split payment = 5<\/li>\n <li>Plugin = 6<\/li>\n <li>POS = 7<\/li>\n<\/ul>"},"receivedAt":{"type":"string","description":"The time the payment was received"},"importedAt":{"type":"string","description":"The time the payment was imported"},"status":{"type":"integer","description":"The <a href=\"https:\/\/developers.plentymarkets.com\/en-gb\/developers\/main\/rest-api-guides\/getting-started.html#_payment_status_ids\" target=\"_blank\">status<\/a> of the payment"},"transactionType":{"type":"integer","description":"The transaction type of the payment. The following transaction types are available:\n<ul>\n <li>Interim transaction report = 1<\/li>\n <li>Booked payment = 2<\/li>\n <li>Split payment = 3<\/li>\n<\/ul>"},"mopId":{"type":"integer","description":"The ID of the payment method"},"regenerateHash":{"type":"boolean","description":"If $regenerateHash is true, regenerate the payment hash value. Default is false."},"updateOrderPaymentStatus":{"type":"boolean","description":"If $updateOrderPaymentStatus is true, update the order payment status. Default is false."},"isSystemCurrency":{"type":"boolean","description":"If $isSystemCurrency is false, the value will be converted to the standard currency with the provided exchange rate. If $isSystemCurrency is true, the value is not converted. Default is true."}}},"PaymentHistory":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the payment history"},"paymentId":{"type":"integer","description":"The ID of the payment"},"typeId":{"type":"integer","description":"The ID of the history type. The following types are available:\n<ul>\n <li>Created = 1<\/li>\n <li>Status updated = 2<\/li>\n <li>Assigned = 3<\/li>\n <li>Detached = 4<\/li>\n <li>Deleted = 5<\/li>\n <li>Updated = 6<\/li>\n<\/ul>"},"value":{"type":"string","description":"The value of the payment history"},"user":{"type":"string","description":"The user who initiated the action"}}},"PaymentProperty":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the payment property"},"paymentId":{"type":"integer","description":"The ID of the payment"},"typeId":{"type":"integer","description":"The ID of the property type. The following property types are available:\n<ul>\n <li>Transaction ID = 1<\/li>\n <li>Reference ID = 2<\/li>\n <li>Booking text = 3<\/li>\n <li>Transaction password = 4<\/li>\n <li>Transaction code = 5<\/li>\n <li>Authorisation ID = 6<\/li>\n <li>Capture ID = 7<\/li>\n <li>Refund ID = 8<\/li>\n <li>Credit note ID = 9<\/li>\n <li>Order reference = 10<\/li>\n <li>Name of the sender = 11<\/li>\n <li>Email of the sender = 12<\/li>\n <li>The sender's sort code = 13<\/li>\n <li>The sender's bank name = 14<\/li>\n <li>The sender's bank account number = 15<\/li>\n <li>The holder of the bank account = 16<\/li>\n <li>The country of the sender's bank account = 17<\/li>\n <li>The sender's IBAN = 18<\/li>\n <li>The sender's BIC = 19<\/li>\n <li>Name of the recipient = 20<\/li>\n <li>The recipient's bank account = 21<\/li>\n <li>Reference text of the payment = 22<\/li>\n <li>Payment origin = 23<\/li>\n <li>Shipping address ID = 24<\/li>\n <li>Invoice address ID = 25<\/li>\n <li>Item buyer = 26<\/li>\n <li>Item number = 27<\/li>\n <li>Item transaction ID = 28<\/li>\n <li>External transaction type = 29<\/li>\n <li>External transaction status = 30<\/li>\n <li>The receiver's IBAN = 31<\/li>\n <li>The receiver's BIC = 32<\/li>\n <li>Transaction fee = 33<\/li>\n <li>Transaction lifespan = 34<\/li>\n <li>Matching rate = 36<\/li>\n<\/ul>"},"value":{"type":"string","description":"The value of the property type"}}},"PaymentMethodName":{"type":"object","properties":{"paymentMethodId":{"type":"integer","description":""},"lang":{"type":"string","description":""},"name":{"type":"string","description":""}}},"PaymentMethod":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the payment method"},"pluginKey":{"type":"string","description":"The plugin key of the payment method"},"paymentKey":{"type":"string","description":"The payment key of the payment method"},"name":{"type":"string","description":"The name of the payment method"},"isDocumentBuilderActive":{"type":"boolean","description":"Flag that indicates if payment method is checked for document builder"}}},"PaymentPropertyType":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property type"},"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."},"position":{"type":"integer","description":"The position number of the property type"}}},"ItemSerialNumber":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the serial number"},"orderId":{"type":"integer","description":"The ID of the order"},"orderItemId":{"type":"integer","description":"The ID of the order item"},"itemId":{"type":"integer","description":"The ID of the item"},"serialNumber":{"type":"string","description":"The serial number"},"createdAt":{"type":"string","description":"The date the serial number was created"}}},"AdditionalSku":{"type":"object","properties":{}},"BundleComponent":{"type":"object","properties":{}},"Client":{"type":"object","properties":{}},"DefaultCategory":{"type":"object","properties":{}},"Image":{"type":"object","properties":{}},"Market":{"type":"object","properties":{}},"MarketIdentNumber":{"type":"object","properties":{}},"Sku":{"type":"object","properties":{}},"Supplier":{"type":"object","properties":{}},"Warehouse":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the warehouse"},"name":{"type":"string","description":"The name of the warehouse"},"note":{"type":"string","description":"A note for this warehouse"},"typeId":{"type":"integer","description":"The id of the warehouse type. The following types are available:\n<ul>\n <li>0 = Sales warehouse<\/li>\n <li>1 = Repair warehouse<\/li>\n <li>4 = Storage warehouse<\/li>\n <li>5 = Transit warehouse<\/li>\n <li>6 = Distribution warehouse<\/li>\n <li>7 = Other<\/li>\n<\/ul>"},"priority":{"type":"integer","description":"The priority of the warehouse. The higher the priority, the more important the warehouse is. The priority is used for automatic warehouse detection."},"allocationReferrerIds":{"type":"array","items":{},"description":"Allocation Referrer Ids by automatic warehouse detection"},"onStockAvailability":{"type":"integer","description":"Displayed availability of a variation if stock is available"},"outOfStockAvailability":{"type":"integer","description":"Displayed availability of a variation if no stock is available"},"splitByShippingProfile":{"type":"boolean","description":"Flag that indicates if for this warehouse orders are split by shipping profiles or not. <ul><li>True = Orders are split by shipping profiles<\/li> <li>False = Orders will not be split by shipping profiles<\/li><\/ul>"},"storageLocationType":{"type":"string","description":"The storage location type. The following types are available: <ul><li>none<\/li> <li>small<\/li><li>medium<\/li> <li>large<\/li> <li>europallet<\/li><\/ul>"},"storageLocationZone":{"type":"integer","description":"The zone that the storage location is in"},"repairWarehouseId":{"type":"integer","description":"The id of the associated repair warehouse"},"isInventoryModeActive":{"type":"boolean","description":"Flag that indicates if the stocktaking mode for this warehouse is active or not. <ul><li>True = active<\/li> <li>False = inactive<\/li><\/ul>"},"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<ul>\n<li>own<\/li>\n<li>amazon<\/li>\n<li>dhlFulfillment<\/li>\n<\/ul>"},"updatedAt":{"type":"string","description":"The updated at timestamp of the warehouse"},"createdAt":{"type":"string","description":"The created at timestamp of the warehouse"}}},"Inheritance":{"type":"object","properties":{}},"Base":{"type":"object","properties":{}},"CursorResult":{"type":"object","properties":{}},"PluginSet":{"type":"object","properties":{"id":{"type":"integer","description":""},"hash":{"type":"string","description":""},"hasSuccessfulBuild":{"type":"boolean","description":""},"parentPluginSetId":{"type":"integer","description":""},"name":{"type":"string","description":""},"description":{"type":"string","description":""}}},"PluginSetsInfo":{"type":"object","properties":{}},"Plugin":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the plugin"},"name":{"type":"string","description":"The name of the plugin"},"position":{"type":"integer","description":"The position of the plugin. The position is used to determine the plugin\norder."},"activeStage":{"type":"boolean","description":"Shows whether the plugin is active in Stage. Inactive plugins will not\nbe provisioned in Stage."},"activeProductive":{"type":"boolean","description":"Shows whether the plugin is active in Productive. Inactive plugins will\nnot be provisioned in Productive."},"created_at":{"type":"string","description":"The date that the plugin was created."},"updated_at":{"type":"string","description":"The date that the plugin was updated last."},"inStage":{"type":"boolean","description":"Shows whether the plugin is provisioned in Stage."},"inProductive":{"type":"boolean","description":"Shows whether the plugin is provisioned in Productive."},"isConnectedWithGit":{"type":"boolean","description":""},"isInstalledWithGit":{"type":"boolean","description":""},"updateInformation":{"type":"array","items":{},"description":""},"type":{"type":"string","description":"The type of the plugin. The following plugin types are available:\n<ul>\n <li>Template<\/li>\n <li>Export<\/li>\n<\/ul>"},"installed":{"type":"boolean","description":"Whether or not the plugin is installed. This will be false for plugins\nthat have been purchased from the marketplace but have not yet been installed in any set."},"version":{"type":"string","description":"The version of the plugin"},"versionStage":{"type":"string","description":"The version of the plugin in stage"},"versionProductive":{"type":"string","description":"The version of the plugin in productive"},"description":{"type":"string","description":"The description text of the plugin"},"namespace":{"type":"string","description":"The namespace of the plugin"},"dependencies":{"type":"array","items":{},"description":"A list of plugins with dependencies to the plugin"},"author":{"type":"string","description":"The name of the plugin author"},"price":{"type":"number","description":"The price of the plugin"},"keywords":{"type":"array","items":{},"description":"A list of plugin keywords"},"require":{"type":"array","items":{},"description":"A list of plugins that are required by the plugin"},"platform":{"type":"array","items":{},"description":"Details about what platform does the plugin support."},"notInstalledRequirements":{"type":"array","items":{},"description":"A list of required plugins that are not installed"},"notActiveStageRequirements":{"type":"array","items":{},"description":"A list of required plugins that are not active in stage"},"notActiveProductiveRequirements":{"type":"array","items":{},"description":"A list of required plugins that are not active in productive"},"runOnBuild":{"type":"array","items":{},"description":"The list of classes to execute once on plugin build"},"checkOnBuild":{"type":"array","items":{},"description":"The list of classes to execute on every plugin build"},"authorIcon":{"type":"string","description":"The author icon"},"pluginIcon":{"type":"string","description":"The plugin icon"},"license":{"type":"string","description":"The plugin license"},"shortDescription":{"type":"array","items":{},"description":""},"isClosedSource":{"type":"boolean","description":"is closed source"},"inboxPath":{"type":"string","description":"path in the inbox (closed source, open source)"},"marketplaceName":{"type":"array","items":{},"description":"The plugin name displayed in marketplace"},"source":{"type":"string","description":"Whether this plugin was installed from marketplace, git or local"},"javaScriptFiles":{"type":"array","items":{},"description":"A list of included javascript files"},"containers":{"type":"array","items":{},"description":"A list of provided containers with name and description"},"dataProviders":{"type":"array","items":{},"description":"A list of data providers with name and description"},"categories":{"type":"array","items":{},"description":""},"webhookUrl":{"type":"string","description":"webhookUrl"},"isExternalTool":{"type":"boolean","description":"is external tool"},"directDownloadLinks":{"type":"array","items":{},"description":"A list of urls for the external tool"},"forwardLink":{"type":"string","description":"A forward link to the external tool developers page"},"branch":{"type":"string","description":"The branch to checkout for this particular Plugin"},"commit":{"type":"string","description":"The commit to checkout for this particular Plugin"},"offerTrial":{"type":"boolean","description":"Determines if the plugin offers a trial period for plentyMarketplace"},"offerFreemium":{"type":"boolean","description":"Determines if the plugin offers freemium functionality"},"pluginSetIds":{"type":"array","items":{},"description":"Array of PluginSet Ids where this plugin is contained."}}},"PluginSetEntry":{"type":"object","properties":{"id":{"type":"integer","description":""},"pluginId":{"type":"integer","description":""},"pluginSetId":{"type":"integer","description":""},"branchName":{"type":"string","description":""},"commit":{"type":"string","description":""},"position":{"type":"integer","description":""},"isInstalledFromGit":{"type":"boolean","description":""}}},"Webstore":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the client (store)"},"name":{"type":"string","description":"The name of the client (store)"},"type":{"type":"string","description":"The type of the client (store)"},"storeIdentifier":{"type":"integer","description":"The identifier of the client (store)"},"pluginSetId":{"type":"integer","description":"The plugin set id of the client (store)"}}},"Configuration":{"type":"object","properties":{"id":{"type":"integer","description":""},"key":{"type":"string","description":""},"value":{"type":"string","description":""},"plugin_id":{"type":"integer","description":""},"tab":{"type":"string","description":""},"label":{"type":"string","description":""},"type":{"type":"string","description":""},"possibleValues":{"type":"array","items":{},"description":""},"default":{"type":"string","description":""},"scss":{"type":"boolean","description":""},"updated_at":{"type":"string","description":""},"pluginSetEntryId":{"type":"integer","description":""}}},"PropertyAmazon":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property amazon"},"propertyId":{"type":"integer","description":"The property ID of the property amazon"},"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"}}},"PropertyAvailability":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property availability"},"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"}}},"PropertyGroupOption":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property group option"},"groupId":{"type":"integer","description":"The property group ID of the property group"},"type":{"type":"string","description":"The identifier of the property group option"},"value":{"type":"string","description":"The value of the property group option"}}},"PropertyMarket":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property market"},"propertyId":{"type":"integer","description":"The ID of the property"},"referrerId":{"type":"number","description":"The ID of the referrer"},"referrerSubId":{"type":"integer","description":"The ID of the sub referrer"},"value":{"type":"string","description":"The value of the property market"}}},"PropertyOption":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property option"},"propertyId":{"type":"integer","description":"The property ID of the property option"},"type":{"type":"string","description":"The identifier type of the option"},"value":{"type":"string","description":"The value of the option"}}},"PropertyRelation":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property relation"},"propertyId":{"type":"integer","description":"The property ID of the property relation"},"type":{"type":"string","description":"The type of the property relation"},"targetId":{"type":"string","description":"The ID of the target of the property relation"},"groupId":{"type":"integer","description":"The property group ID of the property relation"},"markup":{"type":"number","description":"The mark up of the property relation"},"value":{"type":"string","description":"The value of the property relation for properties of the following type: int, float, date and file."}}},"PropertyRelationValue":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property relation value"},"relationId":{"type":"integer","description":"The ID of the property relation"},"lang":{"type":"string","description":"The language of the property relation value"},"value":{"type":"string","description":"The value of the property relation"},"description":{"type":"string","description":"The description of the property relation value"}}},"RepairReason":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the repair reason."},"reason":{"type":"string","description":"The specified reason in system language."}}},"RepairStatus":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the repair status."},"status":{"type":"string","description":"The specified status in system language."}}},"ReturnReason":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the return reason."},"reason":{"type":"string","description":"The specified reason in system language."}}},"ReturnStatus":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the return status."},"status":{"type":"string","description":"The specified status in system language."}}},"ContentLink":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the content link"},"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."},"active":{"type":"boolean","description":"Indicates if the link is active and the content should be visible for the frontend."},"relatedContentType":{"type":"string","description":"The content type the content is linked to"},"relatedContainerName":{"type":"string","description":"The container name the content is linked to"},"inherit":{"type":"boolean","description":"Indicates if this content should be inherited to child contents."},"invalid":{"type":"boolean","description":"Indicate if the content is invalid and should be regenerated on next request."}}},"Content":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the content"},"dataProviderName":{"type":"string","description":"The name of the data provider"},"type":{"type":"string","description":"The type of the content"},"widgets":{"type":"string","description":"The configured widgets of the content. This attribute is deprecated. Use $dropzones instead."},"dropzones":{"type":"array","items":{},"description":"Dropzones of the content"}}},"ContentPage":{"type":"object","properties":{"identifier":{"type":"string","description":"The identifier of the content page"},"caption":{"type":"string","description":"Translation key to read the caption from"}}},"SearchResult":{"type":"object","properties":{"value":{"type":"string","description":""},"label":{"type":"string","description":""},"source":{"type":"string","description":""}}},"Reservation":{"type":"object","properties":{"id":{"type":"string","description":""},"initialId":{"type":"string","description":""},"transactionId":{"type":"string","description":""},"variationId":{"type":"integer","description":""},"warehouseId":{"type":"integer","description":""},"storageLocationId":{"type":"integer","description":""},"batch":{"type":"string","description":""},"difference":{"type":"number","description":""},"reason":{"type":"string","description":""},"priority":{"type":"integer","description":""},"mayBecomePending":{"type":"boolean","description":""},"timeToLive":{"type":"integer","description":""}}},"Stock":{"type":"object","properties":{"itemId":{"type":"integer","description":"The ID of the item"},"variationId":{"type":"integer","description":"The ID of the variation"},"warehouseId":{"type":"integer","description":"The ID of the warehouse"},"stockPhysical":{"type":"number","description":"The physical stock"},"reservedStock":{"type":"number","description":"The reserved stock"},"reservedEbay":{"type":"number","description":"The stock reserved for ebay"},"reorderDelta":{"type":"number","description":"The reorder delta"},"stockNet":{"type":"number","description":"The net stock"},"reordered":{"type":"integer","description":"The reordered quantity of a variation"},"warehousePriority":{"type":"integer","description":"The priority of the warehouse"},"reservedBundle":{"type":"number","description":"Reserved bundle"},"averagePurchasePrice":{"type":"number","description":"The average purchase price"},"averageSale":{"type":"number","description":"The average sale"},"updatedAt":{"type":"string","description":"The time the stock was last updated"}}},"VariationStockRedistribution":{"type":"object","properties":{"variationId":{"type":"integer","description":"The ID of the variation"},"reasonId":{"type":"integer","description":"The reason for the redistribution. Valid reasons are:\n<ul>\n <li>401: Stock transfer<\/li>\n <li>402: Stock correction by stocktaking<\/li>\n <li>403: Stock transfer because of need for repair<\/li>\n<\/ul>"},"quantity":{"type":"number","description":"The quantity to redistribute"},"bestBeforeDate":{"type":"string","description":"The best before date of the redistribution"},"batch":{"type":"string","description":"The batch of the redistribution"},"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"}}},"StorageLocation":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the storage location."},"warehouseId":{"type":"integer","description":"The id of the warehouse the storage location belongs to."},"rackId":{"type":"integer","description":"The id of the rack the storage location belongs to."},"shelfId":{"type":"integer","description":"The id of the shelf the storage location belongs to."},"name":{"type":"string","description":"The name of the storage location."},"type":{"type":"integer","description":"The type of the storage location. Valid strings are: 'small', 'medium', 'large', 'europallet'."},"position":{"type":"integer","description":"The position of the storage location."}}},"VariationStockIntake":{"type":"object","properties":{"variationId":{"type":"integer","description":"The ID of the variation"},"warehouseId":{"type":"integer","description":"The ID of the warehouse"},"storageLocationId":{"type":"integer","description":"The ID of the storage location"},"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"},"supplierId":{"type":"integer","description":"The ID of the supplier"},"currency":{"type":"string","description":"The currency"},"exchangeRate":{"type":"number","description":"The exchange rate"},"quantity":{"type":"number","description":"The quantity of a variation"},"purchasePrice":{"type":"number","description":"The purchase price"},"bestBeforeDate":{"type":"string","description":"The best before date of the variation"},"batch":{"type":"string","description":"The batch of the variation"},"reasonId":{"type":"integer","description":"The ID of the reason. The following IDs are available:\n<ul>\n<li>101: Incoming items<\/li>\n<li>102: Booked in by stocktaking<\/li>\n<li>104: Rebooked into stock because no production errors were found<\/li>\n<li>106: Maculation canceled<\/li>\n<li>107: Packing error, items are re-booked<\/li>\n<li>109: Incoming items (logistics)<\/li>\n<li>115: Incoming items (second choice)<\/li>\n<li>116: Booked in by correction<\/li>\n<li>117: Unpacked item<\/li>\n<li>180: Incoming items (purchase order)<\/li>\n<li>181: Incoming items (warehousing)<\/li>\n<\/ul>"}}},"VariationStockDischarge":{"type":"object","properties":{"variationId":{"type":"integer","description":"The ID of the variation"},"warehouseId":{"type":"integer","description":"The ID of the warehouse"},"storageLocationId":{"type":"integer","description":"The ID of the storage location"},"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"},"supplierId":{"type":"integer","description":"The ID of the supplier"},"currency":{"type":"string","description":"The currency"},"exchangeRate":{"type":"number","description":"The exchange rate"},"quantity":{"type":"number","description":"The quantity of a variation"},"bestBeforeDate":{"type":"string","description":"The best before date of the variation"},"batch":{"type":"string","description":"The batch of the variation"},"reasonId":{"type":"integer","description":"The ID of the reason. The following IDs are available:\n<ul>\n<li>201: Outbound items<\/li>\n<li>202: Outbound inventur<\/li>\n<li>205: Outbound rubbish<\/li>\n<li>206: Outbound packing error<\/li>\n<li>207: Outbound defect<\/li>\n<li>208: Outbound complaint<\/li>\n<li>209: Outbound logistic<\/li>\n<li>214: Outbound warehouse movement<\/li>\n<li>215: Outbound second choise<\/li>\n<li>216: Outbound correction<\/li>\n<li>280: Outbound purchase order<\/li>\n<li>281: Outbound loss<\/li>\n<\/ul>"}}},"VariationStockCorrection":{"type":"object","properties":{"variationId":{"type":"integer","description":"The ID of the variation"},"warehouseId":{"type":"integer","description":"The ID of the warehouse"},"storageLocationId":{"type":"integer","description":"The ID of the storage location"},"quantity":{"type":"number","description":"The quantity of the variation"},"bestBeforeDate":{"type":"string","description":"The best before date of the variation"},"batch":{"type":"string","description":"The batch of the variation"},"reasonId":{"type":"integer","description":"The reason for correction. The following reasons are available:\n<ul>\n<li>301: Stock correction<\/li>\n<li>302: Stock correction by stocktaking<\/li>\n<li>304: Stock correction because of manufacturer error<\/li>\n<li>305: Stock correction because of unusable paper<\/li>\n<li>306: Stock correction because of packing error<\/li>\n<li>307: Stock correction because of damage<\/li>\n<li>309: Stock correction (internal offset)<\/li>\n<li>317: Stock correction because of BBD<\/li>\n<li>318: Stock correction because of shipping items to FBA<\/li>\n<li>319: Stock correction because of shipping items to fulfillment service provider<\/li>\n<li>320: Stock correction because of sample for interested parties<\/li>\n<li>321: Stock correction because of sample for customers<\/li>\n<li>322: Stock correction because of sample<\/li>\n<li>323: Stock correction because quality models are booked in<\/li>\n<li>324: Stock correction because quality models are booked out<\/li>\n<li>325: Stock correction because of gift<\/li>\n<li>326: Stock correction because of malfunction (without return)<\/li>\n<li>327: Stock correction because of loss<\/li>\n<li>328: Stock correction because of unpack<\/li>\n<\/ul>"}}},"CloudMetricsList":{"type":"object","properties":{"page":{"type":"integer","description":""},"totalsCount":{"type":"integer","description":""},"isLastPage":{"type":"boolean","description":""}}},"TaricVatAssignment":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the taric vat assignment"},"taricCode":{"type":"integer","description":"The taric code"},"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."}}},"TagAvailability":{"type":"object","properties":{"tagId":{"type":"integer","description":"The Tag ID of the tag"},"tagType":{"type":"string","description":"The type of the tag. The following types are available.\n<ul>\n<li>blog<\/li>\n<li>category<\/li>\n<li>content_page<\/li>\n<li>variation<\/li>\n<li>ticket<\/li>\n<li>board<\/li>\n<li>order<\/li>\n<\/ul>"}}},"TagClient":{"type":"object","properties":{"id":{"type":"integer","description":"The id of the relation"},"tagId":{"type":"integer","description":"The Tag ID of the tag"},"plentyId":{"type":"integer","description":"The PlentyId of the client"}}},"TagName":{"type":"object","properties":{"id":{"type":"integer","description":"The name ID of the tag"},"tagId":{"type":"integer","description":"The tag ID"},"tagLang":{"type":"string","description":"The lang of the tag name."},"tagName":{"type":"string","description":"The name of the tag."}}},"TagRelationship":{"type":"object","properties":{"tagId":{"type":"integer","description":"The ID of the tag"},"type":{"type":"string","description":"The type of the relationship"},"value":{"type":"string","description":"The value of the relationship"},"UUID5":{"type":"string","description":"The UUID5 of the relationship"}}},"Ticket":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the ticket"},"typeId":{"type":"integer","description":"The type ID of the ticket"},"priorityId":{"type":"integer","description":"The priority ID of the ticket"},"parentTicketId":{"type":"integer","description":"The ID of the parent ticket"},"statusId":{"type":"integer","description":"The status ID of the ticket"},"confidential":{"type":"array","items":{},"description":"The confidential value. Displays 1 if the ticket is confidential. Displays 0 if the ticket is not confidential."},"contactId":{"type":"integer","description":"The ID of the contact that is linked with the ticket"},"orderId":{"type":"integer","description":"The ID of the order linked with the ticket"},"createdAt":{"type":"string","description":"The time the ticket was created as unix timestamp or carbon object"},"updatedAt":{"type":"string","description":"The time the ticket was last updated as unix timestamp or carbon object"},"contactLastUpdateAt":{"type":"string","description":"The time the contact was last updated"},"deadlineAt":{"type":"string","description":"The date of the ticket deadline"},"finishedAt":{"type":"string","description":"The date the ticket is solved and displays 100 percent in the progress bar"},"title":{"type":"string","description":"The title of the ticket"},"progress":{"type":"integer","description":"The progress of the ticket in percent"},"plentyId":{"type":"integer","description":"The ID of the client (store)"},"source":{"type":"array","items":{},"description":"The source of the ticket. Possible values are 'frontend', 'backend', 'ebay' and 'email'."},"documentsCount":{"type":"integer","description":"The number of documents that are attached to the ticket"},"hasDocuments":{"type":"integer","description":"Displays 1 if the ticket has one or more documents. Displays 0 if the ticket has no document."},"childrenCount":{"type":"integer","description":"The number of child tickets"},"resubmissionAt":{"type":"string","description":"The date the ticket should be resubmitted"},"parseData":{"type":"string","description":"The ParseData from the ticket"}}},"TicketOwner":{"type":"object","properties":{"ticketId":{"type":"integer","description":"The ID of the ticket"},"userId":{"type":"integer","description":"The user ID of the owner"},"roleId":{"type":"integer","description":"The role ID of the owner"}}},"TicketMessage":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the message"},"ticketId":{"type":"integer","description":"The ticket ID the message belongs to"},"userId":{"type":"integer","description":"The user of the message"},"createdAt":{"type":"string","description":"The time the ticket message was created as unix timestamp or carbon object"},"text":{"type":"string","description":"The content of the message"},"type":{"type":"array","items":{},"description":"The type of the message. Two types are available:\n<ul>\n<li>message (visible for the customer)<\/li>\n<li>comment (not visible for the customer)<\/li>\n<\/ul>"},"source":{"type":"array","items":{},"description":"The origin of the message. The following sources are available by default and cannot be deleted.\n<ul>\n<li>backend<\/li>\n<li>frontend<\/li>\n<li>ebay<\/li>\n<li>email<\/li>\n<\/ul>"},"topicId":{"type":"integer","description":"The ID of the topic the message is assigned to"}}},"TicketStatusName":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the status name"},"statusId":{"type":"integer","description":"The status ID of the status name"},"lang":{"type":"string","description":"The language of the status name"},"name":{"type":"string","description":"The name of the status"}}},"TicketTypeName":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the role name"},"typeId":{"type":"integer","description":"The type id of the role name"},"lang":{"type":"string","description":"The language of the role name"},"name":{"type":"string","description":"The name of the role"}}},"Todo":{"type":"object","properties":{"id":{"type":"integer","description":""},"flag":{"type":"integer","description":""},"userId":{"type":"integer","description":""},"priorityId":{"type":"integer","description":""},"progress":{"type":"number","description":""},"title":{"type":"string","description":""},"description":{"type":"string","description":""},"category":{"type":"string","description":""}}},"ChannelMap":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the channel map"},"name":{"type":"string","description":"The name of the channel map"},"marketplace":{"type":"string","description":"The marketplace of the channel map"},"":{"type":"integer","description":"iteration The catalog iteration"},"catalog_id":{"type":"string","description":"The catalog ID of the channel map"},"template_ids":{"type":"string","description":"The template ID list of the channel map (json)"},"status_id":{"type":"integer","description":"The status ID of the map generation"},"build_status":{"type":"string","description":"The build status of the map generation"},"is_building":{"type":"boolean","description":"The bool build status of the map generation"}}},"PropertyGroupRelation":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property group relation"},"propertyId":{"type":"integer","description":"The ID of the property"},"groupId":{"type":"integer","description":"The ID of the property group"}}},"PropertyRelationSelection":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property relation selection value"},"relationId":{"type":"integer","description":"The relation ID of the property relation selection value"},"selectionId":{"type":"integer","description":"The selection ID of the property relation selection value"}}},"PropertySelectionName":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the property selection name"},"selectionId":{"type":"integer","description":"The selection ID of the property selection name"},"lang":{"type":"string","description":"The language of the property selection name"},"name":{"type":"string","description":"The name of the property selection name"},"description":{"type":"string","description":"The description of the property selection name"}}},"Vat":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the VAT configuration. A VAT configuration includes 4 VAT rates"},"countryId":{"type":"integer","description":"The ID of the country that the VAT configuration belongs to"},"taxIdNumber":{"type":"string","description":"The tax id number of VAT configuration."},"economicIdNumber":{"type":"string","description":"The economic 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"},"locationId":{"type":"integer","description":"The ID of the location"},"marginScheme":{"type":"string","description":"Specifies the tax rate that is used, when the margin scheme is applied. Available values: 'none', 'vat1', 'vat2', 'vat3', 'vat4'."},"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."},"isStandard":{"type":"boolean","description":"Flag that indicates if the VAT configuration is the standard VAT configuration for the location"},"createdAt":{"type":"string","description":"The date at which the VAT configuration was created."},"updatedAt":{"type":"string","description":"The date that the VAT configuration was last updated."},"isActive":{"type":"boolean","description":"Is this the active VAT configuration for this location and country? (read-only)"}}},"VatRate":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the VAT rate"},"vatRate":{"type":"number","description":"The percentage of the VAT rate, e.g. 19.00 for 19 %"},"name":{"type":"string","description":"The name of a VAT rate"},"revenueAccount":{"type":"string","description":"The revenue account for the VAT rate"}}},"WarehouseLocationDimension":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the storage location dimension"},"parentId":{"type":"integer","description":"The parent ID of the storage location dimension"},"warehouseId":{"type":"integer","description":"The warehouse ID of the storage location dimension"},"level":{"type":"integer","description":"The level of the storage location dimension"},"name":{"type":"string","description":"The name of the storage location dimension"},"shortcut":{"type":"string","description":"The shortcut of the storage location dimension"},"separator":{"type":"string","description":"The separator of the storage location dimension"},"displayInName":{"type":"integer","description":"If true, the dimension prefix will be shown in the storage location name"},"isActiveForPickupPath":{"type":"integer","description":"Active flag for pickup path of the storage location dimension"}}},"WarehouseLocation":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the storage location"},"levelId":{"type":"integer","description":"The level ID of the storage location"},"label":{"type":"string","description":"The label of the storage location"},"purposeKey":{"type":"string","description":"The purpose key of the storage location"},"statusKey":{"type":"string","description":"The status key of the storage location"},"position":{"type":"integer","description":"The position of the storage location"},"fullLabel":{"type":"string","description":"The label with level path name"},"type":{"type":"string","description":"The type of the storage location (array values: 'small','medium','large','europallet')"},"notes":{"type":"string","description":"The notes of the storage location"}}},"WarehouseLocationInventory":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the storage location"},"userId":{"type":"integer","description":"The user ID of the storage location"},"user_id":{"type":"integer","description":"deprecated - use userID instead"},"status":{"type":"integer","description":"The status of the storage location stocktaking"},"warehouseLocationId":{"type":"integer","description":"The storage location ID"},"warehouse_location":{"type":"integer","description":"deprecated - use WarehouseLocationId"}}},"WarehouseLocationLevel":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the storage location level"},"parentId":{"type":"integer","description":"The parent ID of the storage location level"},"dimensionId":{"type":"integer","description":"The storage location dimension id of the storage location level"},"position":{"type":"integer","description":"The position of the storage location level"},"name":{"type":"string","description":"The name of the storage location level"},"type":{"type":"string","description":"The type of the storage location ['small','medium','large','europallet']"},"pathName":{"type":"string","description":"The complete path name from the level"}}},"Wizard":{"type":"object","properties":{"title":{"type":"string","description":"The title"},"key":{"type":"string","description":"The wizard's key"},"settingsHandlerClass":{"type":"string","description":"Settings handler"},"shortDescription":{"type":"string","description":"The short description"},"translationKey":{"type":"string","description":"The translation key"},"deleteConfirmationText":{"type":"string","description":"Delete confirmation Text in deletion overlay"},"topics":{"type":"array","items":{},"description":"The topics"},"steps":{"type":"array","items":{},"description":"Wizard's structure"},"priority":{"type":"integer","description":"Wizard's listing priority in the overview"},"relevance":{"type":"string","description":"Wizard's level of relevance"},"keywords":{"type":"array","items":{},"description":"Keywords describing the wizard"}}}}} |