{"openapi":"3.0.3","info":{"version":"1.0.0","title":"OTTO Market API","x-logo":{"url":"https://nonlive.portal.otto.market/static/assets/images/otto_market_logo_borderless.svg","backgroundColor":"#ffffff"},"description":"# Home\nWelcome to OTTO Market API Documentation.\nOn this page you will find all information on how to use the API for your business.\nPlease scroll to the top if you´re looking for the OpenAPI specification to download.\n\n## Become an OTTO Market partner (seller)\nFollow these steps:\n- Go visit [otto.market](https://www.otto.market)\n- Inform yourself about our benefits\n- Register as a partner\n- Get access to our partner portal \"OTTO Partner Connect (OPC)\"\n- Provide all necessary documents and data & sign the contract\n- Request your API user on OPC\n\n## Process Workflow\n\nGiven below is the overall process workflow of how different services interact within otto market.\n\n $\"Process$ \n\n## General Changelog\nThis changelog will contain information about important changes. Most important things are legal\nissues, version upgrades and not backward compatible changes.\nNewest information will be placed on top of the table.\n\n| Date | Interface | Classification | Description |\n|------------|-----------------------------------------------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| 2023-07-03 | [OTTO Market Developer Program](https://developer.otto.market/en/home.html) | Published | The OTTO Market Developer Program is now available to the public |\n| 2023-01-11 | [Receipts](../docs#tag/Receipts-V3) | New Version | Version 3 is now live. We plan to go offline with Version 2 (v2) by 2023-07-11 |\n| 2022-09-22 | [Products](../docs#tagProducts-V3) | New Version | Version 3 is now live. We plan to go offline with Version 2 (v2) by 2023-03-31 |\n| 2022-05-25 | General | Documentation | Starting 2022-11-01 redundant domains to access OTTO Market API doc will be decomissioned. Please use access docs using api.otto.market |\n| 2022-03-17 | [Quantities](../docs#tag/Quantities-V2) | Sandbox | Version 2 of /quantities is now available in the sandbox environment. |\n| 2022-01-19 | [Price reductions](../docs#tag/Price-Reductions-V1) | New API | Added price reduction APIs |\n| 2021-11-26 | [Products](../docs#tag/Products-V2) | Sandbox | Version 2 of /products is now available in the sandbox environment. |\n| 2021-04-30 | [Orders](../docs#tag/Orders-V4) | New Version | Version 4 is now live. We plan to go offline with Version 3 (v3) by 2021-10-31 |\n| 2021-04-06 | [Products](../docs#tag/Products-V2) | New Version | Version 2 is now live. We plan to go offline with Version 1 (v1) earliest by 01.11.2021. |\n| 2020-04-14 | [Receipts](../docs#tag/Receipts-V2) | New Version | Version 2 is now live. We plan to go offline with Version 1 (v1) earliest by 14th October,2020. |\n| 2020-04-20 | [Orders](../docs#tag/Orders-V4) | New Version | Version 3 is now live. We plan to go offline with Version 2 (v2) earliest by 01.11.2020. |\n| 2019-09-01 | [Orders](../docs#tag/Orders-V4) | New Version | Version 1 will be outdated in some time. Please change to version 2, if it is marked as ready. |\n| 2022-02-28 | [Price Reductions](../docs#tag/Price-Reductions-V1) | New Version | Version 1 is now live. |\n\n## Feedback\n\nWe are very interested in learning how to enhance our API-Documentation for you and would love to hear from you!\n[Send Feedback.](https://forms.office.com/r/cbnr6tVyyg)\n\n## Get Support\nIf you have any questions, remarks or if you need support, please don't hesitate to contact us and we will get back to you as soon as possible.\n\n- As a **partner** the quickest way to get support is to open a new ticket in [OTTO Partner Connect](https://account.otto.market/s/ticketanlegen) via the Partner Helpdesk choosing the sub-category \"Technische Schnittstellen\".\n- As a **service provider** please [send an e-mail](mailto:partnerintegration@otto.market) to our OTTO Market team.\n\n## Access to the API\n\n| Environment | Base URL |\n|-------------|---------------------------------|\n| Sandbox | https://sandbox.api.otto.market |\n| Production | https://api.otto.market |\n\n# OTTO Market API Developer's Guide\nThe Developer's Guide is targeted at developers and people with technical background who are already a partner (seller) of OTTO Market or are interested in becoming a partner.\nThe aim is to help you as a partner of OTTO Market to connect to and to work with the OTTO Market API.\nIt describes some common implementation patterns and helps you to understand how processes work.\nDetailed information about the concrete interfaces can be accessed by clicking onto the single tabs.\n\n## Authorization (OAuth2)\n\n### Fetching an Access Token\nTo access the Otto Market API, you need to authenticate your API user account and obtain an access token. This section describes how to obtain an access token using the password grant type.\n\n#### Requesting an Access Token\nTo request an access token, send a POST request to the /token endpoint of the Otto Market API with the following parameters:\n\n* username: Your API user account username.\n* password: Your API user account password. Make sure to URL-encode any special characters.\n* grant_type: Set to \"password\" to indicate that you're using the password grant type to obtain an access token.\n* client_id: Identifies your application to the API. Set to \"token-otto-api\".\n\nFor example, you can use the following cURL command to retrieve your access token:\n\n```\ncurl -X POST \\\nhttps://api.otto.market/v1/token \\\n-H 'Content-Type: application/x-www-form-urlencoded' \\\n-H 'Cache-Control: no-cache' \\\n-d 'username=&password=&grant_type=password&client_id=token-otto-api'\n```\n\nNote that you need to include your own username and password in the cURL command and URL-encode any special characters. For example, if your password is \"my!@password\", you would include it in the command above as \"my%21%40password\".\n\nAlternatively, you can let cURL encode the POST data by using --data-urlencode instead:\n\n```\ncurl -X POST \\\n https://api.otto.market/v1/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -H 'Cache-Control: no-cache' \\\n --data-urlencode username= \\\n --data-urlencode password= \\\n --data-urlencode grant_type=password \\\n --data-urlencode client_id=token-otto-api\n\n```\n#### Response\n\nIf your request is successful, the API server responds with an access token in a JSON object that looks like this:\n\n```\n{\n \"access_token\": \"eyJhbGciOiJSUzI1NiISNCXIgiLCJSZWNla[...omitted for brevity...]\",\n \"expires_in\": 1800,\n \"refresh_expires_in\": 7200,\n \"refresh_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCIgOO[...omitted for brevity...]\",\n \"token_type\": \"bearer\",\n \"not-before-policy\": 0,\n \"session_state\": \"3e0710b2-b57a-4cb0-a51d-6de60a997356\",\n \"scope\": \"pumba-roles-app-portal partner email profile\"\n}\n```\n\nThe \"access_token\" property contains the access token that you can use to authenticate subsequent requests to the Otto Market API. Make sure to include the access token in the Authorization header of your API requests, using the Bearer token type.\n\n\n### Example\nHere's an example cURL command that retrieves a list of products from the Otto Market API, using the access token obtained in the previous step:\n```\ncurl -X GET \\\nhttps://api.otto.market/v2/products \\\n-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...' \\\n-H 'Cache-Control: no-cache'\n```\nThis cURL command sends a GET request to the /v2/products endpoint of the Otto Market API, with the Authorization header set to the access token obtained in the previous step. The -H 'Cache-Control: no-cache' option is included to ensure that the server doesn't return a cached response.\n\n#### Best-practice when renewing a token\n\nUse available tokens as long as possible before fetching a new `access_token`. In general new access_tokens should be fetched by using\nthe `refresh_token`. Expiration date of an access token is indicated by the attribute `expires_in` for access_tokens\nand `refresh_expires_in` for refresh_tokens. Please bear in mind that a refresh token can only be used once.\nIn other words, once a refresh token is used to obtain a new access token, then the same refresh token cannot be reused even if it has not yet expired.\n\n\n### Use refresh token\nA single refresh token can only be used to obtain a new access token, if\n\n1) The refresh token has not expired, and\n2) The refresh token has not been used before.\n\nThe refresh token can be extracted from the refresh_token value.\nOnce the access token has expired or is going to be expired, you should use the refresh token to get a new\naccess token, without using your users credentials again. You can use the\nfollowing cURL command. Include the refresh token (without leading and trailing < >).\n```\ncurl -X POST \\\n https://api.otto.market/v1/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -H 'cache-control: no-cache' \\\n -d 'refresh_token=&grant_type=refresh_token&client_id=token-otto-api'\n```\n\nThe response of this request will look like the example above, the access token\ncan be extracted from access_token and the new\nrefresh token from refresh_token.\n\n## API Access for Partner cooperating with a Service Provider\n`Note:` *This feature is not available for all partners. If you want access, create a support ticket for the category [Technische Schnittstellen](https://portal.otto.market)*\n\nIf you are cooperating with a Service Provider you will get a link for installing an app of this Service Provider. In order to do so follow the steps below:\n1. Login to [OTTO Partner Connect (OPC)](https://portal.otto.market) portal.\n2. Click on the link you got from the Service Provider (either directly or from e.g. the homepage of this Service Provider).\n3. You will be asked to grant consent that the app is allowed to access the scopes displayed in the consent screen (e.g., products or orders).\n If you don't grant consent nothing will happen. The app won't be installed and thus won't be able to access your data.\n `Note:` *In order to install the app you have to grant access to all the specified scopes. Allowing only a part of them is not possible.*\n4. If you grant consent the app is \"installed\" and you can use it. It is now also displayed in the installed apps tab (\"Installierte Apps\") on the [service provider page (\"Dienstleister\")](https://portal.otto.market/settings/Dienstleister)\n\n### Revoke Consent\n\nIf you want to revoke your consent you can do so by navigating to the overview of your installed apps (\"Installierte Apps\") on the [service provider page (\"Dienstleister\")](https://portal.otto.market/settings/Dienstleister). Hover over the app name to get the Button for revoking consent (\"Zugriff entziehen\"). When clicking on this button you get a popup window asking you to confirm that you want to revoke your consent. If you do so, the app gets uninstalled meaning it has no longer access to your data and you cannot use it any longer. Of course, you can re-install the app if you want to.\n\n## API Access for Service Providers\nRefer [Developer Program](/docs#section/Developer-Program) section below for more details about authentication and authorization. Once you have authentication and authorization,\nread further for the next steps.\n\n## Calling an Endpoint\nAll endpoints are secured via authorization. You add the HTTP Authorization\n-Header with value Bearer ey... and will get access.\n```\ncurl -X GET \\\n https://api.otto.market/v2/orders \\\n -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5jdhstdheSldUIiwia2lkIiA6ICI4T1d6MjhuZ01GbHBURDl5TGtxQkRHMThuYXZNVFgyTWtqNVhkY0RITDBZIn0.eyJqdGkiOiI5OTM1NDk3OS1iNDdhLTQ3MzctOWYyMy0yNTMyMmI5MGVmYmMiLCJleHAiOjE1NTM3NjQ4NjMsIm5iZiI6MCwiaWF0IjoxNTUzNzYxMjYzLCJpc3MiOiJodHRwczovL2VzYi13cy5vdHRvLmRlL3NlYy1hcGkvYXV0aC9yZWFsbXMvcGFydG5lci1hcGktdGVzdCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI0MWUwNGQ1OS0xMTk0LTRiYjMtODhkYS1hYjRmNTk2NDkwZGUiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJwYXJ0bmVyLWFwaSIsImF1dGhfdGltZSI6MCwic2Vzc2lvbl9zdGF0ZSI6IjliNjk1ZDA1LTY5YzQtNDkwZS1hZGIzLTc2YWE5NmJmZjA0YyIsImFjciI6IjEiLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoiZW1haWwgcHJvZmlsZSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJwYXJ0bmVyIjoiMTAwMDYyNCIsIm5hbWUiOiJTb3VsZXdheSIsInByZWZlcnJlZF91c2VybmFtZSI6IjEwMDA2MjQiLCJnaXZlbl9uYW1lIjoiU291bGV3YXkifQ.SleUexNdapaY5RmrVTbKRMiVpRrbNLjIUi7fILsW1hkpqQbX4IQRaSufSt98Ar0OkEmIvZvYPpGVecmjwYvD3YQzBmlcdU0V544Y0h8y01RyxZAYGZbRXfA1kOsFDucnrClCcj1JIaQMU4629wU9OM_SdQaLvfTA2l5prma94RekdWR3S-6DzXqJDtHrrcYS8BsfohkuLdi1U8vPUjwee9lsY3RTa9YZVekH4hFVWMl0Pbwub8jwum6zRjTu-ZAiLhZSnl8mSaMtrJFmkzRi3-s9eN7k0lnLKWGt7JuqZ_vbiJT8ZhHvPur4eLrY02ehF6-lwSUyjWMCzCi5TjBgYg'\n```\n\nThe expected result has an HTTP 200 code with a probably empty list.\n\n## Rate Limiting\nA high volume of calls on API services at any given time would increase server resource consumption. If the load is due to an unauthorized intrusion it would be a chaos. Thus, rate limiting becomes extremely important.\n\nIn general authenticated API calls are limited for each partner to 20 requests per second.\nExceeding the rate limit results in a HTTP 429 \"too many requests\" error.\nFor some endpoints the rate limit is lower to ensure the best quality for all API users. Please see below:\n\n|Endpoint path|HTTP method|Max requests per time unit|\n|:-|:-|:-|\n|/products|GET|10 per second|\n|/products|POST|20 per second|\n|/products/active-status|GET|10 per second|\n|/products/active-status|POST|3600 per day|\n|/products/marketplace-status|GET|10 per second|\n|/products/categories|GET|10 per second|\n|/products/brands|GET|10 per second|\n|/v1/token|POST|10 per second for each IP|\n|other endpoints|POST & GET|20 per second|\n\n### User Based API Throttling\nA general method of limiting usage of API resource is to allocate a pre-configured static or dynamic quota for a consumer. The API rate limiting is done on the basis of partner-id. A particular partner-id can make 20 requests per second.\n\n### Best Practice\nPlease divide your requests over the day and avoid sending all data at once. Make use of the individual limits for the interfaces. This helps preventing our systems from clogging and ensures a flawless experience for everyone.\n\n## Timeouts and Defaults\n| Name | Value | Description |\n|-----------------|-------|-----------------------------------------------------------------------------------------------------------------|\n| request timeout | 10s | The maximum HTTP request timeout for all interfaces |\n| limit | 128 | The default for limit query parameter. See Paging. The default limit can be overwritten in specific interfaces. |\n\n## Common Patterns\n### Interface Definition\nOur REST interface definitions are basically using swagger.io.\nAll interface definitions can be automatically used by you to generate necessary API objects and similar in\nyour chosen implementation language.\nIn order to remain technically extensible and up-to-date, individual interfaces may have been\ndescribed in new or different definition schemes. We are constantly trying to keep all interfaces\ntechnically up to date.\n\n### Versioning\nThe OTTO Market API uses different versions for the single endpoints. The version number is included in the URL path.\n[Semantic versioning](https://semver.org/) scheme is used, but only the major version. Breaking changes are only introduced in new major versions. API version is required in all urls.\n\nEndpoints may introduce new optional fields at any time in the request and any new fields in the response. The client must skip all unknown fields.\n\nFor every endpoint, a changelog exists which displays the latest released changes and the upcoming unreleased changes. Additionally, an overall [Changelog](/) exists with the most exciting changes about the API in general.\n\n### Supporting old versions\nThe OTTO Partner API continues to support old versions of an API for **6 months** from the time of public announcement for the new version of a given API.\nIt is recommanded to check regularly. This can be be automated by checking HTTP headers for the attribute `SunsetHeader`, which indicates when versions go offline.\n\n#### Best-practice\nRegurlarly check for the `SunsetHeader` and act as soon as the attribute appears by updating your integration to the new version within the presented time frame.\n\n__example:__\n```\nWarning: v2 is deprecated. Please migrate to v3\nSunset: Sun, 01 Nov 2020 00:00:00 GMT\nDeprecation: Wed, 11 Nov 2018 23:59:59 GMT\nLink: ; rel=\"successor-version\"\n```\n\n## Header\nSome common headers should be set by clients:\n\n1. Set the X-Request-Timestamp header according to the [ISO-8601](https://tools.ietf.org/html/rfc3339#section-5.6) standard. You can use this regex pattern: ^\\d{4}-(0\\d|1[0-2])-([0-2]\\d|3[01])T(2[0-3]|[01]\\d):[0-5]\\d:[0-5]\\d(\\.\\d+)?(\\[+-](2[0-3]|[01]\\d):[0-5]\\d|Z)$\n2. Set Accept to the desired response format e.g. application/json\n3. Set the Content-Type header to define the used format in the request body, only applicable if you send a request body\n\n## HTTP Methods\nThe interfaces describe which HTTP methods are allowed and how to use them.\nOur basic concern is that basically all HTTP Methods are allowed in the [standardized way](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol).\nNote that these methods should behave as specified by their\n[standardized meaning (idempotency)](http://restcookbook.com/HTTP%20Methods/idempotency/).\nThe following is a description of a few special features, relevant facts or ways to use some of the HTTP methods.\n

Click to expand for details

\n\n### POST\nPOST will update specific fields **and** returns the result like a GET would do (error response is independent).\n\n### PUT\nPUT will create or replace the whole entity independent of an existing entity.\n\n### PATCH\nPATCH will update specific fields **and** not return data like a GET would do (error response is independent).\nPATCH body is structured in the same way as PUT and POST (entity body).\nAll fields added into your body will be updated, other fields will not be affected.\n\n__example:__\n```\n{\n \"username\" : \"myusername\",\n \"email\" : null\n}\n```\n

\n\n## HTTP Status Codes\nWe are using [standardized HTTP status code](https://www.restapitutorial.com/httpstatuscodes.html)\nwith a body only if needed (it also just can be empty), but details about that you can find at the\nconcrete interface implementation.\n\n| Verb | Description |\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| HEAD | Can be issued against any resource to get just the HTTP header info. |\n| GET | Used for retrieving resources. |\n| POST | Used for creating resources. |\n| PATCH | Used for updating resources with partial JSON data. For instance, an Issue resource has title and body attributes. A PATCH request may accept one or more of the attributes to update the resource. PATCH is a relatively new and uncommon HTTP verb, so resource endpoints also accept POST requests. |\n| PUT | Used for replacing resources or collections. For PUT requests with no body attribute, be sure to set the Content-Length header to zero. |\n| DELETE | Used for deleting resources. |\n\n## Error Message Style\nError messages are returned as content type \"application/json;charset=utf-8\" in the following format:\n```\n{\n \"errors\": [\n {\n \"path\": \"/orders/1000331\",\n \"title\": \"Invalid Attribute\",\n \"code\": \"490\",\n \"detail\": \"First name must contain at least three characters.\",\n \"detail-structured\": {...},\n \"jsonpath\": \"[@.orderid=='12345']/invoiceAddress/firstname\",\n \"logref\": \"key to find in the log\"\n }\n ],\n \"warnings\": [\n {\n \"path\": \"/orders/1000331\",\n \"title\": \"Warning Attribute\",\n \"code\": \"WRONG_SPELLING\",\n \"detail\": \"Last name should start with big letter.\",\n \"detail-structured\": {...},\n \"jsonpath\": \"[@.orderid=='12345']/invoiceAddress/lastname\",\n \"logref\": \"key to find in the log\"\n }\n ]\n}\n```\n\n| Field | Mandatory | Description |\n|-------------------|-----------|------------------------------------------------------------------------------------------------------|\n| path | yes | called REST path |\n| title | yes | short description of the error |\n| code | no | internal error code (number or enum) of your application / domain (do not use the HTTP status codes) |\n| detail | no | long description of the error, perhaps technical details |\n| detail-structured | no | technical details in JSON structure |\n| jsonpath | no | JSON field in request which caused the error |\n| logref | no | reference key to find more stuff in the log (as example traceId) |\n\n## Pagination\nInterfaces may return a list with resources (orders, shipments...) and a way to navigate these lists. Please pay attention to the response pattern to identify how to handle lists. There are two common ways list handling is implemented. One way to retrieve the next entry of a list is by using links for navigation the entries. The other is by providing list pages to iterate through lists.\n\nFor pagination, the basic query parameter \"limit\" (e.g. ?limit=10) can be used to define the maximum amount of resulting entities returned per call. The interface itself can reduce the limit lower than your client limit.\n\nAn example entity using links (not pages) to navigate would be:\n```\n{\n resources: [\n {\n ...data of the entity if all or some information will be provided directly...,\n links: [\n {\n href: \"/v1/orders/1234\", <--- Link to single partner order\n rel: \"self\"\n }\n ]\n }\n ],\n links: [\n {\n href: \"/v1/orders?idGt=1234\", <--- Link to next list of ressources. If not present, no more records exist, currently\n rel: \"next\"\n }\n ]\n}\n```\n\n## Bulk requests\nAttention: When sending bulk requests to any /products API endpoint, it will be processed asynchronously at the backend.\n\n### Synchronous Answer\nSynchronously will be delivered an endpoint to check the asynchronous processing state.\n```\nHTTP STATUS 202 (Accepted)\n{\n \"task\": {\n \"href\": \"/interface/foo/123\",\n \"id\": \"123\"\n }\n}\n```\n\n### Check the State of an Endpoint\nThe client can follow the href to check the state of processing.\n\n#### Best-practice:\nAs long as the `state = pending` the attribute `pingAfter` dictates when to send a new request.\n\nAn example entity would be:\n```\n{\n \"state\": \"pending\",\n \"message\": \"is running boy\",\n \"progress\": \"35\",\n \"total\": \"100\",\n \"pingAfter\": \"2019-05-01T13:25:12+0200\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"/foo/bar/123\"\n },\n {\n \"rel\": \"failed\",\n \"href\": \"/foo/bar/123/failed\"\n },\n {\n \"rel\": \"succeeded\",\n \"href\": \"/foo/bar/123/succeeded\"\n }\n ]\n}\n```\n\n### Fetching files like PDF and CSV\n\nClients don't have to know the filetype that will be returned from a resource.\nResources serving files will have the appropriate file extension in the URL as shown in the example below.\n\n**Request Headers**\n```\nGET /SomeInvoice.pdf HTTP/1.1\nAccept: */*\n```\n\nClients can find out the mime-type from the Content-Type header that will be sent in the response (e.g. application/pdf for PDF files and application/csv for CSV files).\n\n**Response Headers**\n\n ```\nHTTP/1.1 200 OK\nContent-Length: 514493\nContent-Type: application/pdf\n```\n\n## Common fields\nCommon fields like time, currency, country codes etc need to follow the standard ISO guidelines unless mentioned otherwise. The fields must report the format they are following on the docs.\n\n### Some standard formats:\n- Time: Accept in any time zone in ISO-8601 format and always reply in UTC.\n\n Example: `YYYY-MM-DD` and `hh:mm:ss.sss`: `2020-03-12` and `22:33:34.400`\n- Currency: ISO-4217.\n\n Example: `EUR` for Euros, `GBP` for British Pound Sterling.\n- Country code: ISO-3166-1 alpha-3\n\n Example: `DEU` for Germany, `NOR` for Norway.\n\n# Use-Cases\n\n## How to list your first product\n\n*This sections goal is to guide you through our API docs and help you list your first product on the OTTO Market.\nYou´ll find short introductions to the steps to be taken followed by a link to the technical documentation for that step.*\n\nTo list a product you´ll have to do the following:\n\n1. Authenticate\n2. Read valid brands\n3. Read valid categories\n4. Post product\n5. Check update-tasks\n6. Check marketplace status\n7. Update quantities\n\n### Authenticate\nWe´ll have to start by authenticating to the OTTO Market Server by posting our credentials to fetch an access token\nhttps://api.otto.market/docs#section/OTTO-Market-API-Developer's-Guide/Authorization-(OAuth2)\n\n### Read valid brands\nNext we´ll have to read the valid brands. You can only sell brands where the attribute \"usable\" = true.\nhttps://api.otto.market/docs#tag/Products-V3/operation/Products-V3__getBrands\n\n### Read valid categories\nFollowing that we´ll need to read the valid categories to know which category to list our products in.\nWe´ll also be able to read from the list which attributes are mandatory when listing in a specific category.\nhttps://api.otto.market/docs#tag/Products-V3/operation/Products-V3__getCategoryGroups\n\n### Post product\nWe´ve gathered a valid brand and category, know which attributes are mandatory and now it´s finally time to post our first product.\nBy reading the documentation mentioned below you´ll learn which values (e.g. EAN, SKU, productDescription, ...) are required.\nYou´ll also find an example request on this page.\nhttps://api.otto.market/docs#tag/Products-V3/operation/Products-V3__createOrUpdateProductVariations\n\n### Check update-tasks\nIf you´ve successfully posted your product from the step before you´ll have to check for errors by addressing the \"Update-Tasks\".\nYou´ll see the success state of your listing. If there were errors you´ll have to solve these and post your updated product listing again.\nDon´t forget to check the update-tasks another time before carrying on.\n**Attention!** Posting the exact same data a second time is a bad idea since our server is configured to ignore duplicate listings.\nhttps://api.otto.market/docs#tag/Products-V3/operation/Products-V3__progressByProcessId\n\n### Check marketplace status\nLast validation step for your product is to check the marketplace status of your SKU.\nThrough Update-Tasks you´ll see if there are non-technical errors you´ll have to solve.\nhttps://api.otto.market/docs#tag/Products-V3/operation/Products-V3__getMarketPlaceStatus\n\n### Update quantities\nLastly you´ll have to set the quantities of your product so customers can finally see and buy your product.\nhttps://api.otto.market/docs#tag/Quantities-V2/operation/Quantities-V2__storeAvailableQuantitiesUsingPOST\n\n**Congratulations!** You´ve successfully listed your first product on the OTTO Market.\nThe next step is to regularly check for new orders. [Click here to learn how to do that.](https://api.otto.market/docs#tag/Orders-V4/operation/Orders-V4__findPartnerOrders)\n\n## Manage an order from start to finish\n\n*This sections goal is to guide you through our API docs and help you fulfilling your first order including subsequent activities on the OTTO Market.\nYou´ll find short introductions to the steps to be taken followed by a link to the technical documentation for that step.*\n\nTo fulfill your first order and manage subsequent activities you´ll have to do the following:\n\n1. Authenticate\n2. Regularly check for new orders\n2. Report order as shipped\n3. Regularly screen for return announcements\n4. Process returns\n5. Give subsequent discounts (price-reductions)\n6. Fetch order receipt\n\n### Authenticate\nWe´ll have to start by authenticating to the OTTO Market Server by posting our credentials to fetch an access token\nhttps://api.otto.market/docs#section/OTTO-Market-API-Developer's-Guide/Authorization-(OAuth2)\n\n### Regularly check for new orders\nNext we´ll have to regurlarly check for new orders to fulfill. We recommend checking several times a day.\nYou´ll find the different fulfillment states orders can have, their descriptions and common use-cases listed at the top of [this page](https://api.otto.market/docs#tag/Orders-V4/operation/Orders-V4__findPartnerOrders).\nTo carry on with fulfilling your first order the state has to be = PROCESSABLE.\nhttps://api.otto.market/docs#tag/Orders-V4/operation/Orders-V4__findPartnerOrders\n\n### Report order as shipped\nPackaging the ordered items is next before you can hand them to your carrier and mark the order as shipped.\nWe´ll call it a shipment from this point onward. Every shipment needs a tracking key and unless it´s a forwarder shipment you´ll also have to provide a returnTrackingKey upfront. Please read the following endpoint for all technical information:\nhttps://api.otto.market/docs#tag/Shipments-V1/operation/Shipments-V1__createdAndSentShipmentUsingPOST\nFor this example we´ve presumed you´ll send all ordered items with the same shipment. If you needto split an order into different shipments, please use [this endpoint](https://api.otto.market/docs#tag/Shipments-V1/operation/Shipments-V1__createdAndSentMultiparcelShipmentUsingPOST).\n\n### Regularly screen for return announcements\nCustomers may want to return their order wholly or partially. Return labels will be created through their customer interface and the return status will change to announced. It is recommended to regularly check for announced returns using the following endpoint:\nhttps://api.otto.market/docs#tag/Returns-V2/operation/Returns-V2__getPositionItemsForUsingGETV2\n\n### Process returns\nReceived returns have to be checked by your warehouse and either accepted or rejected depending on the condition of the return.\nAccepting a return will lead to a customer repayment. You can accept returns using this endpoint:\nhttps://api.otto.market/docs#tag/Returns-V2/operation/Returns-V2__receiveAcceptedReturnsV2UsingPOSTV2\n\nIf the condition of the return is unacceptable you´re able to reject the return. If you do so you have to submit a reason for the rejection:\nhttps://api.otto.market/docs#tag/Returns-V2/operation/Returns-V2__receiveRejectedReturnsV2UsingPOSTV2\n\n### Give subsequent discounts (price-reductions)\nIf a customer is unsatisfied with the condition of the item he or she will usually return it. Depending on the product and the condition the customer might be interested in keeping the product if a discount is given. Customers usually contact you or OTTO to discuss such an option.\nThe following endpoint documentation describes how you´re able to provide such a \"price-reduction\":\nhttps://api.otto.market/docs#tag/Price-Reductions-V1/operation/Price-Reductions-V1__applyPriceReduction\n\n### Fetch order receipt\nThe last step when managing orders is to fetch the receipt. We provide different options to fetch receipts.\nYou can either fetch the receipt PDF oder JSON object for a specific receipt or get a list of receipts as JSON objects.\nYou´ll have to limit the amount of receipts for the latter option using parameters:\nhttps://api.otto.market/docs#tag/Receipts-V3/operation/Receipts-V3__getReceiptsUsingGET_5\n\n**Attention:**\nPlease for your own interest, hand over all receipt types you are interested in using the new list parameter receiptTypes, so that OTTO Market could add new receipt types without side effects for your own processes.\nUsing this option you can decide by your own when to incorporate new receipt types in your own processes.\nPlease do not use the possibility of calls without specifying the receiptTypes anymore.\n\n# Sandbox\n\n### General\n**Sandbox is the test environment,**\nused for testing an API connection. It provides all the functionalities of the live OTTO Market Interface. All actions and orders there are simulated for testing purposes.\n\nThe login session and the API key in the sandbox environment are completely separated from the production environment.\n\nREST API: **https://sandbox.api.otto.market**\n\n## Getting started\nFollow these steps to start testing on our sandbox environment:\n\n1. Make yourself familiar with sandbox functionalities.\n2. Request a sandbox API user:\n As a **partner (seller)** the fastest way is to open a new ticket in [OTTO Partner Connect](https://account.otto.market/s/ticketanlegen) through the Partner Helpdesk choosing the sub-category \"Technische Schnittstellen\".\n As a **service provider** please register in our [OTTO Market Developer Program](https://developer.otto.market/).\n\n3. Authenticate to our sandbox environment. See [DevelopersGuide](/docs#section/Partner-API-Developer's-Guide) for further information.\n4. Use our Order generator to create fictional orders. See Technical Advice below to know, which orders are created.\n5. Test the API functionality of your application.\n\n## Technical Advice\nPlease note the following information:\n### Authorization\nFor the endpoint like all the other endpoints a valid authorization token has to\nbe sent. If you need further information, please consult the [Developers\nGuide](/docs#section/Partner-API-Developer's-Guide).\n\n### GET-Returns Endpoint\nSince there are no real costumers, returns cannot be announced. Hence, the GET endpoint of returns is retrieving an empty string.\n\n### Sandbox Reset\nTo prevent data overload, our sandbox and its orders are reset monthly at first Sunday from 6 p.m. to 10 p.m.\\\nAny dynamic data (shipments, returns) is deleted. Old shipments will not be available anymore.\\\nTherefore, you have to create new orders every month.\n\n### Order Generator\nTo test your API implementation you can generate test orders only on the sandbox environment by sending an empty POST request to the following generation endpoint:\n\n[https://sandbox.api.otto.market/v4/orders/testorders]()\n\nThis will run 8 predefined scenarios on our sandbox. After the POST request, you will receive 6 orders in \"PROCESSABLE\" status with different combinations of positions and items (e.g. standard and freight delivery). You will also receive 1 prepayment order in \"ANNOUNCED\" and 1 order in \"CANCELLED_BY_MARKETPLACE\" status.\n\nThe generated orders will contain one or more position items with the following products:\n\n| Product Title | EAN | SKU |\n|-------------------------------------|---------------|-----------------------|\n| Smartphone »CallMe 1000« | 1245780164732 | SmartCM1000-schwarz-1 |\n| Fancy Shirt »Flower« | 4851278936452 | FancyFlower-m-pi |\n| Rasenmaeher »Turbo V1« | 9821393948573 | 0440-Rasen-T-V1 |\n| Spedition Wohnlandschaft 3.tlg. | 8263748321943 | Sped-Wohn-3-98735 |\n| Spedition Kühlschrank »COOL EXTREM« | 7263000981290 | Sped-Kühl084-kombi |\n\nScenarios:\n\n| Scenarios | Status | Comment |\n|------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------|\n| 1, 2, 3, 4, 7, 8 | PROCESSABLE | Scenario 4 inclusive discount |\n| 5 | ANNOUNCED | Order with payment method PREPAYMENT awaiting customer's payment
Order includes weeePickup on position item level |\n| 6 | CANCELLED_BY_MARKETPLACE | Order with payment method PREPAYMENT which has been cancelled since the customer didn't pay |\n\nPlease use the generated orders to test the interaction with Orders, Shipments and Returns.\n\nIf you want to create a single scenario you can do that by sending an empty POST to:\n\n[https://sandbox.api.otto.market/v4/orders/testorders/scenario\\{scenarionumber\\}]()\n\ne.g. [https://sandbox.api.otto.market/v4/orders/testorders/scenario1]()\n\n## Best-practice test cases\n\nWe´ve come up with mulitple test cases to help you test the basic functionalities needed for each endpoint when offering your service to an OTTO Market Seller.\nThe test cases should be tested within the sandbox environment. If you´re interested in feedback from our service provider management you can send screenshots of the test results [here](mailto:partnerintegration@otto.market?subject=[OTTO%20Market%20API]%20Service%20Provider%20test%20cases).\n\nWe´re referring to the test orders created using the *test order generator* within the sandbox environment. Please read the section [Order Generator](#order-generator) on how to create test orders.\n\n### Products\nWe want to test the successful and incorrect creation of several products as well as the deactivation of the\nproducts. The successful display of the errors and OTTO categories should also be tested.\n\n1. Download the valid category list over the appropriate endpoint and load it into your mapping interface.\n\n**Attention:** Please remember to show your customer the `featureRelevance` and `relevance` of attributes. `LEGAL` attributes are mandatory.\n\n2. Download the valid brand list over the appropriate endpoint and load it into your system.\n\n3. List a product with 8 SKUs of a valid brand and a valid category.\n\n4. Try listing a product with a wrong brand, a wrong category, an attribute with a wrong name and a wrong value.\n\n5. Please deactivate a SKU from the product created in test case 1 and send us a screenshot of the deactivation display in your\n system.\n6. To test all Go-Live processes please have a look at the following section and perform all three test cases shown to ensure the correct handling of the MOIN and the marketplace-status: [Products:-Validation-and-test-cases](#Products:-Validation-and-test-cases)\n\n### Quantities\nWe want to test the successful transfer of inventory to existing SKUs.\n\n7. Please send a positive inventory via the interface for three of the successfully submitted SKUs.\n\n**Attention:** Inventory updates should only be updated when the quanities have changed for a product. That being said a common best practice is to atleast align the stock keeping system with the OTTO Market once a day. Maybe at night.\n\n### Orders\nWe want to test the processes for pulling orders in different statuses using self-generated test orders. The\ncancellation process is also to be tested.\n\n8. Generate the collection of 16 test orders (in 8 scenarios) via the order generator and pull the orders in the status \"PROCESSABLE\".\n\n9. GET the orders in the status \"ANNOUNCED\".\n\n10. Use one of the orders from test scenario 2 and cancel it via the corresponding interface.\n\n11. Use one of the orders from scenario 7 and simply cancel an item from the order using the appropriate interface.\n\n### Shipments\nWe want to test the shipping processes and consider the special feature of the returnTrackingKey for\nparcel shipping. Test cases for parcel shipping and forwarding shipping are to be executed.\n\n12. Use one of the orders from scenario 1 and report the items in a shipment as shipped.\n\n13. Use one of the orders from scenario 1 and report two different shipments (two package shipments) for the four items.\n\n14. Use one of the orders from scenario 3 and report the item as shipped in a shipment.\n\n15. Use one of the orders from scenario 8 and report all items in separate shipments as shipped (parcel shipping + freight\n forwarding shipping)\n\n### Returns\nFinally, the return case should be checked and a return accepted and rejected for an item successfully\nmarked as shipped.\n\n16. Use the order marked as shipped from test case 10 and report the items as accepted returns (acceptance).\n\n17. Use the order marked as shipped from test case 12 and report the item as an unaccepted return (rejection).\n\n### Receipts\n\nAfter the successful shipment or return process a new receipt will be created. For each shipment you will find a purchase receipt and for each return accepted you can find a refund receipt.\n\n18. Use the order marked as shipped from testcase 12 and download the specific purchase receipt as a JSON with the salesOrderId as parameter.\n\n20. Use the order marked as returned from testcase 16 and download the specific refund receipt as a JSON with the salesOrderId as parameter.\n\n22. For partial_refund receipts you can either filter by using the salesOrderId as parameter (if you happen to know when exactly in which salesOrderId a partial_refund was set) or the parameter receiptTypes=”PARTIAL_REFUND” togehter with the parameters from=yyyy-mm-dd and to=yyyy-mm-dd to get all partial_refund receipts for a specific time frame.\n\n**Please note:** Partial_refund will be set after the customer complained and the seller want to grant a refund).\nMostly this process happens manually via the OTTO Partner Connect Portal but is also available via the API Price-Reductions)\n\n\n## Products: Validation and test cases\n\nWe want to test the successful and incorrect creation of several products as well as the deactivation of the products.\nThe successful display of product related errors, OTTO categories and brands should also be tested.\n\n### Validation\n\nSubmitted product data is validated in two steps:\n\n**1. Technical validation**\n\nThe first technical validation (syntax and required attributes) takes place after you´ve sent product data using a POST request.\nRead more about uploading products here: OTTO Market API: Create or update your product variations.\nIf your http request was successful (http response state 200), you´ll be provided with four different links (pending, succeeded, failed, unchanged).\nFollowing the links you´ll be able to check which products have been successfully listed, failed, unchanged or are still being processed.\n\n|Status|Explanation|\n|:-|:-|\n|Pending|The product listing is still being processed|\n|Succeeded|The shown products listing was successful|\n|Failed|Listing of all shown products has failed|\n|Unchanged|The request for the listed products is unchanged to the last request|\n\n**2. Shop validation**\n\nThe second step is the shop validation. Results of the shop validation are retrievable using the marketplace-status endpoint.\nPlease read OTTO Market API: Read the marketplace status on how to use the marketplace status endpoint.\nSubmitted product data always has one of the following four marketplace statuses:\n\n| Status | Explanation |\n|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Pending | Submitted product data is currently proceeded. |\n| Online | The SKU is displayed at otto.de. You can find the SKU using the shop link.
In some cases, additional information will be shown on how to improve the visibility on otto.de. |\n| Restricted | The SKU is not displayed at otto.de because of an error shown within the error’s container. |\n| Inactive | The SKU was set inactive via the active-status endpoint and could be reactivated via the active-status endpoint. |\n\n**Attention:** Since the sandbox is missing a direct shop integration the second validation is simulated.\n\n### Test cases\n\nTo ensure you´re able to test every marketplace status including different errors we´ve added specific EAN´s to our sandbox environment.\nBelow you´ll find predefined test cases to simulate possible cases from the live environment.\nAs mentioned before the different states are retrievable fetching the marketplace status.\n\n**Test case #1: Status Online with poor data quality:**\n\nA product status can be online but still have poor data quality.\nTo increase the visibility please add the listed attributes from the error message (“{0}”).\n\nThis state can be tested by listing SKU´s using one or more of the following EAN´s:\n\n- “6250000000010”\n- “6250000000027”\n- “6250000000034”\n- “6250000000041”\n- “6250000000058”\n\nYou should receive an error message that looks anything like this:\n\n800001 - DATAQUALITY_NOTICE_SIGNIFICANT_ATTRIBUTE_AND_INFORMATION:\n“Durch die Pflege folgender Attribute kann die Sichtbarkeit des Produktes gesteigert werden: ''{0}''”\n\n**Test case #2: Status Restricted – Brand blocked**\n\nSome brands are reserved for specific sellers. By listing a product with one of those reserved brands you should receive the following error message:\n\n600007- BRAND_BLOCKED and error title: “Die Marke ist gesperrt und darf nicht eingespielt werden.“\nThis state can be tested by listing SKU´s using one or more of the following EAN´s:\n\n- “6250000000065”\n- “6250000000072”\n- “6250000000089”\n- “6250000000096”\n- “6250000000102”\n\n**Test case #3: Status Restricted – EAN already known**\n\nTo ensure a great customer experience, product listings using the same EAN are grouped on the OTTO market. This leads to seller competition.\nBy listing a product with a yet unknown EAN a new moin will be generated and must be included in all future updates / listings for that EAN.\nThe moin is retrievable via the marketplace status.\n\nBy listing a product with an already known EAN you´ll be prompted with the following error message:\n\n700001 - MOIN_ALREADY_KNOWN and the error title:\n“Diese Variante ist auf dem OTTO Marktplatz bereits bekannt. Um die Variante zum Verkauf anbieten zu können, bestätigen Sie uns bitte den Content,\nindem sie die MOIN beim nächsten Update an uns zurückschicken.“\n\nThe error message says that the EAN is already known and can only be sold by including the moin.\nThe moin is retrievable from the marketplace status. Including the moin means you´re agreeing that you´re selling the exact same product which has\ninitially generated the moin for the EAN you´re trying to sell. If you disagree, please contact support@otto.market.\n\nThe listing of a product with an already known EAN is possible by listing SKU´s using one or more of the following EAN´s:\n\n- “6250000000201”\n- “6250000000300”\n- “6250000000409”\n- “6250000000508”\n- “6250000000607”\n- “6250000000706”\n- “6250000000805”\n- “6250000000904”\n- “6250000001000”\n\n**Test case #4: Status Restricted – MOIN incorrect**\n\nIt´s possible that you´re trying to submit a product including the moin but the moin has a typo / is wrong in general.\nYou´ll receive the following error message then:\n\n700002 – MOIN_INCORRECT and the error title:\n“Die von Ihnen zu dieser Variante übertragene MOIN entspricht nicht der von uns für diese Variante vergebenen MOIN.\nBitte überprüfen Sie ihre Daten und korrigieren die MOIN entsprechend.“\n\nThis is solved by including the correct moin.\n\n\n# Developer Program\nThis section describes how a service provider can integrate with OTTO Market API.\nOur new developer program aims at equipping the service providers with authentication and authorization for accessing the OTTO Market API `on behalf of the partner`.\n\n## Target Group\nThe Developer Program is intended primarily for service providers who want to exchange data for OTTO Market Partners and offer their service to other sellers. OTTO Market Partners who would like to develop their own OTTO Market API connection use their own API user and can find more information here (link https://api.otto.market/docs#section/OTTO-Market-API-Developer's-Guide/Authorization-(OAuth2)).\n\n## Registration as Service Provider\nIf you want to register as a service provider who needs to access Partner data, please follow the steps at [developer.otto.market](https://developer.otto.market/register).\nYou'll receive email notifications for any approval / denial of registration requests.\n\nAfter submitting your registration and a first check, you will receive 30 days' access to the sandbox environment for getting to know the inferfaces and estimate your effort without completing the registration process.\nIf you decide to integrate, complete the registration by filling out the self-disclosure form. You will receive this at the end of the 30-day provisional access period.\n\nUpon successful registration, service provider will be created with private access which can later be changed by raising request in OPC.\n\nFor more information about the registration and integration process, please have a look at [developer.otto.market](https://developer.otto.market).\n\n## Private and Public Access for Service Provider\n\nOnce your registration was successful you have private access to the OTTO Partner Connect portal meaning you can create only private apps in Production environment. (Read more about the difference between private and public apps [here](/docs#section/Developer-Program/Private-and-Public-Apps).)\n\n### Getting Public Access\n\nIf you want to get public access follow the steps below:\n\n1. Login to OTTO Partner Connect portal and navigate to your [profile page (\"Dienstleisterprofil\")](https://portal.otto.market/profile/Dienstleisterprofil)\n2. Check the box at the very bottom stating that you want to get public access\n3. Click on save (\"Speichern\").\n4. Done! Your request will be reviewed by OTTO Market developer team. You'll receive email notifications for approval / denial of your request.\n\n*Please note: Once you have public access this cannot be reverted meaning you cannot request only private access!*\n\n## Private and Public Apps\n\n#### Private Apps\n\nPrivate apps can be created by private as well as public service providers. If a OTTO Market partner wants to install a private app, an unique app invitation link (\"Einladungslink\") is required.\n\n**Generate an app invitation link**\nYou can generate an unique app invitation link for an app by following the steps below:\n\n1. Login to the [OTTO Partner Connect](https://portal.otto.market/profile/Dienstleisterprofil) portal.\n2. Navigate to the [OTTO Market Apps](https://portal.otto.market/app-management/service-provider/apps) and [Sandbox Apps](https://portal.otto.market/app-management/sp-sandbox-apps) page for production and sandbox apps respectively.\n3. Click on the three dots (…) right to the app name for which you want to create an invitation link.\n4. In the dropdown menu select \"Einladungslink generieren\".\n5. A popup window will be displayed. Copy the link from this window - it will not show up again.\n6. Done! You can now share the app invitation link with a OTTO Market partner.\n\n`Note:` You should be aware of the following:\n- After closing the popup window with the invitation link you won't be able to see this exact invitation link again.\n- You can create as much inviation links as you want to.\n- There is no possibility to show all invitation links created for a specific app.\n- Every app invitation link is only valid for 24 hours and can be used only once. (When it is used or expired the link will become invalid and you have to create a new one.)\n- If a partner clicks on the link but don't grant consent the link remains valid (until it is either expired or consent is granted).\n\n#### Public Apps\n\nPublic apps can only be created by public service providers. (For getting public access refer to [Getting Public Access](/docs#section/Developer-Program/Getting-Public-Access).)\nIn order to install a public app, an universally valid installation link (\"Installationslink\") is required. After creating a public app this link is displayed in the app details page. You can share this link whereever you want.\nYou can also add an optional parameter \"state\" to this installation link, which preserves the state of your application page and returns user back to that state after they install. If this optional parameter exists, the user will be redirected to app's callback URL along with the optional state.\nBut be aware that it is universally valid meaning you cannot control which partner will install your app.\n#### Converting a private app into a public app\n\nOnly public service providers have the option to convert private apps into public ones. (For getting public access refer to [Getting Public Access](/docs#section/Developer-Program/Getting-Public-Access).)\n\n`Note:` BEFORE CONVERTING an app to public you should be aware of the following:\n- This action CANNOT be undone meaning you cannot convert a public app back to private.\n- This action has no effect on existing installations of your app. This means that every partner who has installed this app before (via an one-time use app invitation link) can still use it. (They don't need to re-install it or do anything.)\n- Every app invitation link you created before converting the app becomes invalid.\n- An universally valid installation link will be generated and displayed on the app details page.\n\nIn order to convert your private app into a public app follow the steps below:\n\n1. Login to the [OTTO Partner Connect](https://portal.otto.market/profile/Dienstleisterprofil) portal.\n2. Navigate to the [OTTO Market Apps](https://portal.otto.market/app-management/service-provider/apps) page.\n3. Click on the three dots (…) right to the app name for which you want to create an invitation link.\n4. In the dropdown menu select \"App Typ zu 'Public' ändern\".\n5. A popup window will be displayed asking you to confirm that you want to convert this app to public.\n6. Done! Your app is now public.\n\n## Scopes\nScopes corresponds to [OAuth scopes](https://oauth.net/2/scope/). They are used for providing fine-grained access control to the OTTO Market APIs.\n\n### Scopes for OTTO Market APIs\nThe below table gives mapping of displayed scope names in UI to the scope names to be used for fetching token\n\n| Display Name | Scope Name (To be used in fetching token) |\n|-----------------|-------------------------------------------|\n| Installation | installation |\n| PartnerId | partnerId |\n| Developer | developer |\n| Products | products |\n| Orders | orders |\n| Receipts | receipts |\n| Returns | returns |\n| Price Reduction | price-reduction |\n| Shipments | shipments |\n| Quantities | quantities |\n\n### Content declaration of available scopes\n\n#### Installation\nThe installation interface allows a service provider to get the installation details of a Partner\n\n#### PartnerId\nThe partnerId interface allows a service provider, access to the partner's partner id.\n\n#### Developer\nThe developer interface allows a service provider to fetch an installation token\n\n#### Products\n\nThe product interfaces allow partners to manage their product data in the OTTO Market, which means to send products for publishing on OTTO.de, to view the sent data, and to manage the visibility of the products on otto.de.\n\nRead more about the technical possibilities [here](https://api.otto.market/docs#tag/Products-V2).\n\n#### Quantities\n\nOnce the products have been successfully transmitted using the products scope, only the quantities are missing to make the products available to the end customer on otto.de. For this purpose the Quantity Interface allows partners and service providers to update the available quantity for a specific SKU.\n\nRead more about the technical possibilities [here](https://api.otto.market/docs#tag/Quantities-V2).\n\n#### Orders\n\nThis interface allows partners and service providers to view orders and associated position items. It also allows to send cancellations on order and position item level.\n\nRead more about the technical possibilities [here](https://api.otto.market/docs#tag/Orders-V4).\n\n#### Shipments\n\nThis interface should be used to report that shipments have been handed over to the carrier for final delivery to the customer.\n\nRead more about the technical possibilities [here](https://api.otto.market/docs#tag/Shipments-V1).\n\n#### Returns\n\nThis scope enables the user to manage returns. This includes retrieving a list of announced returns, accepting and declining returns.\n\nRead more about the technical possibilities [here](https://api.otto.market/docs#tag/Returns-V2).\n\n#### Receipts\n\nOTTO Market provides receipts to the customers to document financial processes. The scopes enables users to download these documents as a PDF or a JSON.\n\nRead more about the technical possibilities [here](https://api.otto.market/docs#tag/Receipts-V2).\n\n#### Price Reduction\n\nThis endpoint enables sellers to apply price reductions to shipped products if the customer is unsatisfied and asks for a partial refund instead of returning the product completely.\n\nRead more about the technical possibilities [here](https://api.otto.market/docs#tag/Price-Reductions-V1).\n\n## Sandbox vs Production\nSandbox apps are used to test your API in sandbox environment, when you are approved for sandbox by the OTTO Market team. These apps have\nunrestricted scopes access, so you can create sandbox apps for any scope even if you have not yet been approved of it. For creating and testing with sandbox apps,\nplease see [Access to Sandbox and Creating Sandbox Apps](/docs#section/Developer-Program/Access-to-Sandbox-and-Creating-Sandbox-Apps).\n\nAs the name states, production apps are for production environment. This can be created after you have an approval from OTTO Market team for the\nproduction environment. Once you have the approval, you can request for public service provider access, to create public apps.\nAn OTTO Market Partner has to provide consent, in order for you to access their\nproduction data. The detailed flow is described in the [Access to Production and Creating Production Apps](/docs#section/Developer-Program/Access-to-Production-and-Creating-Production-Apps) section below.\n\n\n## Access to Sandbox\nOnce your service provider registration request is approved, you can start using [Sandbox Apps](https://portal.otto.market/app-management/sp-sandbox-apps).\n\n### Creating sandbox test users\nIn [Usermanagement UI](https://portal.otto.market/settings/Nutzerverwaltung) Service Providers can create their own test users for sandbox.\nThis test user can be used for authenticating against sandbox apps\n\nValid email is required for sandbox users. Upon creation of user, a password setting mail will be sent to the given sandbox user emailId\n\n_Note_\n\n- Sandbox users are considered as part of the service provider count itself.\n You can create a max of 10 users (service providers + sandbox) by default.\n\n\n### Creating sandbox apps\nIn create apps UI, you need to provide the following details,\n- unique name\n- homepage URL\n- authorization callback URL - Refer below section for more info\n- [scopes](docs#section/Developer-Program/Scopes) - All scopes will be listed in sandbox.\n- app type - Refer [Private and Public Apps](docs#section/Developer-Program/Private-and-Public-Apps) for more info\n\n#### Authorization callback URL\nYou will receive two types of callbacks to this URL:\n1. Test Partner will be redirected to your authorization callback URL after successfully installing your app.\n2. Post successful redirection, you will initiate authorization code flow. Test Partner logs in with their credential. On verifying identity, partner will be redirected to your app's authorization callback URL with auth code.\n\n#### App ID\nA unique app ID which will be used for identifying a service provider app.\nWhen a partner installs this app, this app ID will be used for fetching the installation details.\n\n#### Installation Link\nThis unique, publicly accessible link will be used by OTTO Market partners for installation.\nAn optional parameter \"state\" can be added to the link to preserve the state of application page. If the parameter exists, the user will be redirected to app's callback URL along with this parameter.\nYou can simply use this link as a hyperlink into your website.\n\n#### Client ID & Client Secret\nCredentials to be used for authenticating & authorising your app with OTTO authorisation server for\nfetching installation details of partner\n\n## Access to Production\nOnce you are satisfied with everything you have tested in the sandbox, email [OTTO Market](mailto://partnerintegration@otto.market) to get access to Production.\nWhen approved, you can start creating production apps using [OTTO Market Apps](https://portal.otto.market/app-management/service-provider/apps) in OTTO Partner Connect.\nAfter getting production access, the service provider can request for public service provider access via OPC to create public apps\n\n### Creating apps\nIn create apps UI, you need to provide the following details,\n- unique name\n- homepage URL\n- authorization callback URL - Refer below section for more info\n- [scopes](docs#section/Developer-Program/Scopes) - Only scopes approved for you will be shown\n- app type (only if the service provider has public access)\n\n#### Authorization callback URL\nYou will receive two types of callbacks to this URL:\n1. Partner will be redirected to your authorization callback URL after successfully installing your app.\n2. Post successful redirection, you will initiate authorization code flow. Partner logs in with their credential. On verifying identity, partner will be redirected to your app's authorization callback URL with auth code.\n\n#### App ID\nA unique app ID which will be used for identifying a service provider app.\nWhen a partner installs this app, this app ID will be used for fetching the installation details.\n\n#### Installation Link\nThis unique, publicly accessible link will be used by OTTO Market partners for installation.\nAn optional parameter \"state\" can be added to the link to preserve the state of application page. If the parameter exists, the user will be redirected to app's callback URL along with this parameter.\nYou can simply use this link as a hyperlink into your website.\n\n#### Client ID & Client Secret\nCredentials to be used for authenticating & authorising your app with OTTO authorisation server for\nfetching installation details of partner\n\n\n\n## Installation of app by an OTTO Partner (Sandbox | Production)\n $\"App$ \n\n1. The partner navigates to your application's installation link and installs your application. If desired, a \"state\" parameter can be added to the installation link for tracking the installer of your application.\n\n2. After successful installation, the partner is redirected to your application's authorization callback URL. If a \"state\" query parameter was included in the installation link, it will be added to the callback URL, redirecting the user upon successful installation.\n\n3. Within your callback logic, authenticate the partner user and obtain an access token by implementing the OAuth2 Authorization Code Flow:\n\n 3.1. Redirect the user to the authorization endpoint with scopes `installation` and `partnerId`. The server should respond with a HTTP 302 response that redirects the user-agent to the authorization URL, which includes parameters like client_id, redirect_uri, response_type, and scope.\n - Sandbox: https://sandbox.api.otto.market/oauth2/auth?response_type=code&client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope=installation%20partnerId\n - Production: https://api.otto.market/oauth2/auth?response_type=code&client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope=installation%20partnerId\n\n Please note that 'REDIRECT_URI' is optional. It serves as the URI where your app can send and receive authentication responses. The protocol, host, and URL path (excluding query parameters) of the 'REDIRECT_URI' must align with your app's authorization callback URL.\n\n 3.2 User logs in and verify their identity\n\n 3.3. After the user grants authorization, your application will receive an authorization code at the redirect URI provided. The server will respond with a HTTP 302 that directs the user-agent to the provided redirect URI.\n\n 3.4. Exchange the authorization code for an access token by making a POST request to the token endpoint, including the authorization code, redirect URI, and client ID in the body. Ensure the `Content-Type` header is set as `application/x-www-form-urlencoded`.\n- Sandbox: https://sandbox.api.otto.market/oauth2/token\n- Production: https://api.otto.market/oauth2/token\n\nFor more information on implementing the OAuth2 Authorization Code Flow, please refer to the [OAuth 2.0 Authorization Code](https://tools.ietf.org/html/rfc6749#section-4.1) section of the OAuth2 standard documentation. You can retrieve the necessary endpoints from the OpenID Connect well-known configuration:\n\n- Sandbox Well-Known Endpoint: [Sandbox Well-Known Endpoint](https://sandbox.api.otto.market/sec-api/auth/realms/deepsea-sandbox/.well-known/openid-configuration)\n- Production Well-Known Endpoint: [Production Well-Known Endpoint](https://api.otto.market/sec-api/auth/realms/otto-partner/.well-known/openid-configuration)\n\n4. Upon successful user authentication, retrieve the Installation ID by sending a GET request to the endpoint `/v1/apps/{appId}/installation`. The domain will be sandbox.api.otto.market or api.otto.market based on whether you're in a sandbox or production environment. Replace `{appId}` with your specific service provider application's unique ID. Use the access token obtained in the previous step.\n\n ```\n GET /v1/apps/{appId}/installation HTTP/1.1\n Host: sandbox.api.otto.market or api.otto.market\n Authorization: Bearer {access_token}\n ```\n\n The response will be:\n\n ```\n {\n \"installationId\": \"string\"\n }\n ```\n\n5. Implement the Client Credentials Flow to fetch an access token with the `developer` scope:\n\n ```\n POST /oauth2/token HTTP/1.1\n Host: sandbox.api.otto.market or api.otto.market\n Content-Type: application/x-www-form-urlencoded\n\n grant_type=client_credentials&client_id={CLIENT_ID}&client_secret={CLIENT_SECRET}&scope=developer\n ```\n\n Replace `{CLIENT_ID}` and `{CLIENT_SECRET}` with your actual client ID and client secret.\n\n6. With the obtained token, retrieve an installation access token by making a POST request to `/v1/apps/{appId}/installations/{installationId}/accessToken`. The request body should be `application/x-www-form-urlencoded` and include the `scope` parameter with the values such as `orders`, `shipments`, `receipts`. Please see [Developer Program](/docs#section/Developer-Program/Scopes) for list of available scopes. Multiple scope values should be space separated.\n\n ```\n POST /v1/apps/{appId}/installations/{installationId}/accessToken HTTP/1.1\n Host: sandbox.api.otto.market or api.otto.market\n Authorization: Bearer {access_token}\n Content-Type: application/x-www-form-urlencoded\n\n scope={SCOPE_VALUES}\n ```\n\n The response will be:\n\n ```\n {\n \"access_token\": \"token\",\n \"expires_in\": 1800\n }\n ```\n\nPlease note that in step 6, the Host header should be either `sandbox.api.otto.market` or `api.otto.market`. Additionally, the Authorization header should include the value `Bearer {access_token}` obtained in step 5.\n\nYou can now use this installation access token to authenticate your requests when accessing OTTO Market APIs. Include the access token in the Authorization header with the value Bearer {access_token} for subsequent API calls.\nPlease note that once the access token expires, repeat steps 5 and 6 to obtain a new access token and installation access token respectively. Use the updated tokens for continued access to OTTO Market APIs.\n"},"servers":[{"url":"https://api.otto.market","description":"Live Server"}],"paths":{"/v3/products":{"get":{"description":"The total number of results could be limited by specifying query parameters. Generally the resulting product variations will be paginated. The default page length is 100 product variations per response, also the page size limit. The links specified in the result can be used to page through the total result space.","operationId":"Products-V3__getPartnerProducts","parameters":[{"description":"search for product variations by their sku value. Use this if your sku values contain slash ('/') or dot ('.') characters.","explode":true,"in":"query","name":"sku","required":false,"schema":{"type":"string"},"style":"form"},{"description":"search for product variations by their productReference value","explode":true,"in":"query","name":"productReference","required":false,"schema":{"type":"string"},"style":"form"},{"description":"search for product variations by their category value","explode":true,"in":"query","name":"category","required":false,"schema":{"type":"string"},"style":"form"},{"description":"search for product variations by their brandId value","explode":true,"in":"query","name":"brandId","required":false,"schema":{"type":"string"},"style":"form"},{"explode":true,"in":"query","name":"page","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"proposed limit for the number of products per response page (at most 100)","explode":true,"in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVariationApiResult__Products-V3"}}},"description":"successful operation"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read the specified product variations. This may be the case, if the user has not the necessary role."}},"summary":"Read product variations","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.otto.market/v3/products?sku=SOME_STRING_VALUE&productReference=SOME_STRING_VALUE&category=SOME_STRING_VALUE&brandId=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET 'https://api.otto.market/v3/products?sku=SOME_STRING_VALUE&productReference=SOME_STRING_VALUE&category=SOME_STRING_VALUE&brandId=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]},"post":{"description":"Returns a process-id to query results. The limit for the number of product variations in one request is 500.","operationId":"Products-V3__createOrUpdateProductVariations","parameters":[{"description":"Holds the optional client side update request timestamp, in ISO DateTime format","example":"2000-10-31T01:30:10.000-05:00","explode":false,"in":"header","name":"X-Request-Timestamp","required":false,"schema":{"format":"yyyy-MM-dd'T'HH:mm:ss.SSSXXX","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProductVariation__Products-V3"},"type":"array"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductProcessProgress__Products-V3"}}},"description":"successful operation"},"202":{"description":"The request for a modification of the specified product variations was accepted and will be executed"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to modify the specified product variations. This may be the case, if the user has not the necessary role."}},"summary":"Create or update product variations","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.otto.market/v3/products \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'X-Request-Timestamp: 2000-10-31T01:30:10.000-05:00' \\\n --header 'content-type: application/json' \\\n --data '[{\"delivery\":{\"deliveryTime\":1,\"type\":\"PARCEL\"},\"pzn\":\"PZN-4908802\",\"releaseDate\":\"2019-10-19T00:00:00Z\",\"mediaAssets\":[{\"location\":\"http://apartners.url/image-location\",\"type\":\"IMAGE\"},{\"location\":\"http://apartners.url/image-location\",\"type\":\"IMAGE\"}],\"productReference\":\"UBN-11779\",\"logistics\":{\"packingUnitCount\":3,\"packingUnits\":[{\"width\":600,\"length\":300,\"weight\":365,\"height\":200},{\"width\":600,\"length\":300,\"weight\":365,\"height\":200}]},\"mpn\":\"H2G2-42\",\"ean\":\"3858389911564\",\"moin\":\"M00A1234BC\",\"sku\":\"3858389911564\",\"productDescription\":{\"description\":\"

Some example words...in bold...some more

\",\"fscCertified\":true,\"disposal\":false,\"manufacturer\":\"3M\",\"productLine\":\"501\",\"productionDate\":\"2021-07-02T09:30:52.093Z\",\"brandId\":\"CMWBBRW2\",\"bulletPoints\":[\"My top key information...\"],\"attributes\":[{\"values\":[\"34\"],\"additional\":true,\"name\":\"Bundweite\"},{\"values\":[\"34\"],\"additional\":true,\"name\":\"Bundweite\"}],\"category\":\"Outdoorjacke\",\"productUrl\":\"http://myproduct.somewhere.com/productname/\",\"bundle\":false,\"multiPack\":true},\"pricing\":{\"sale\":{\"salePrice\":{\"amount\":19.95,\"currency\":\"EUR\"},\"endDate\":\"2019-10-19T09:30:00Z\",\"startDate\":\"2019-10-19T09:30:00Z\"},\"normPriceInfo\":{\"normAmount\":100,\"normUnit\":\"g\",\"salesAmount\":500,\"salesUnit\":\"g\"},\"msrp\":{\"amount\":19.95,\"currency\":\"EUR\"},\"vat\":\"FULL\",\"standardPrice\":{\"amount\":19.95,\"currency\":\"EUR\"}},\"order\":{\"maxOrderQuantity\":{\"quantity\":10,\"periodInDays\":7}}}]' | \\\n http POST https://api.otto.market/v3/products \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN' \\\n X-Request-Timestamp:2000-10-31T01:30:10.000-05:00 \\\n content-type:application/json"}]}},"/v3/products/active-status":{"get":{"description":"The total number of results could be limited by specifying query parameters. Generally the resulting active status values will be paginated. The default page length is 100 active status entries per response, also the page size limit. The links specified in the result can be used to page through the total result space. Replaces corresponding online-status endpoint which now is marked as deprecated.","operationId":"Products-V3__getActiveStatus","parameters":[{"description":"search for product variations by their sku value. Use this if your sku values contain slash ('/') or dot ('.') characters.","explode":true,"in":"query","name":"sku","required":false,"schema":{"type":"string"},"style":"form"},{"description":"search for product variations by their productReference value","explode":true,"in":"query","name":"productReference","required":false,"schema":{"type":"string"},"style":"form"},{"description":"search for product variations by their category value","explode":true,"in":"query","name":"category","required":false,"schema":{"type":"string"},"style":"form"},{"description":"search for product variations by their brand ID value","explode":true,"in":"query","name":"brandId","required":false,"schema":{"type":"string"},"style":"form"},{"explode":true,"in":"query","name":"page","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"proposed limit for the number of active status values per response page (at most 100)","explode":true,"in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveStatusListResponse__Products-V3"}}},"description":"successful operation"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read the active status of the specified product variations. This may be the case, if the user has not the necessary role."}},"summary":"Read active status","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.otto.market/v3/products/active-status?sku=SOME_STRING_VALUE&productReference=SOME_STRING_VALUE&category=SOME_STRING_VALUE&brandId=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET 'https://api.otto.market/v3/products/active-status?sku=SOME_STRING_VALUE&productReference=SOME_STRING_VALUE&category=SOME_STRING_VALUE&brandId=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]},"post":{"description":"Returns a process-id to query results. The limit for the number of product active statuses in one request is 500.","operationId":"Products-V3__updateActiveStatus","parameters":[{"description":"Holds the optional client side update request timestamp, in ISO DateTime format","example":"2000-10-31T01:30:10.000-05:00","explode":false,"in":"header","name":"X-Request-Timestamp","required":false,"schema":{"format":"yyyy-MM-dd'T'HH:mm:ss.SSSXXX","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveStatusListRequest__Products-V3"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductProcessProgress__Products-V3"}}},"description":"successful operation"},"202":{"description":"The request for a modification of the active date of the specified product variation was accepted and will be executed"},"400":{"description":"The request body is no valid JSON document"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to modify the active status of the specified product variations. This may be the case, if the user has not the necessary role."}},"summary":"Update active status","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.otto.market/v3/products/active-status \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'X-Request-Timestamp: 2000-10-31T01:30:10.000-05:00' \\\n --header 'content-type: application/json' \\\n --data '{\"status\":[{\"active\":true,\"lastModified\":\"2019-06-18T06:12:36Z\",\"sku\":\"82388894-5883-488\"},{\"active\":true,\"lastModified\":\"2019-06-18T06:12:36Z\",\"sku\":\"82388894-5883-488\"}]}'"},{"lang":"Shell + Httpie","source":"echo '{\"status\":[{\"active\":true,\"lastModified\":\"2019-06-18T06:12:36Z\",\"sku\":\"82388894-5883-488\"},{\"active\":true,\"lastModified\":\"2019-06-18T06:12:36Z\",\"sku\":\"82388894-5883-488\"}]}' | \\\n http POST https://api.otto.market/v3/products/active-status \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN' \\\n X-Request-Timestamp:2000-10-31T01:30:10.000-05:00 \\\n content-type:application/json"}]}},"/v3/products/brands":{"get":{"description":"Read the list of brands that are known on the Otto market place. The list of brands will be paginated. Brands consist of a name, a brand Id, a (link to a) logo and a boolean useable that lets you know wheter you are allowed to set up variants with this brand on the Otto Marketplace. The default page length is 100 entries per response, the page size upper limit is 1000. The links specified in the result can be used to page through the total result space. Note that there will be no prev link on the first page and no next link on the last page.","operationId":"Products-V3__getBrands","parameters":[{"description":"The RFC7232 If-Match header field in a request requires the server to only operate on the resource that matches at least one of the provided entity-tags. This allows clients express a precondition that prevent the method from being applied if there have been any changes to the resource (see [RFC 7232 Section 3.1](https://tools.ietf.org/html/rfc7232#section-3.1).","example":"7da7a728f910","explode":false,"in":"header","name":"If-Match","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"The RFC7232 If-None-Match header field in a request requires the server to only operate on the resource if it does not match any of the provided entity-tags. If the provided entity-tag is `*`, it is required that the resource does not exist at all (see [RFC 7232 Section 3.2](https://tools.ietf.org/html/rfc7232#section-3.2)","example":"7da7a728f910","explode":false,"in":"header","name":"If-None-Match","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"The RFC7232 If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.","example":"Sat, 29 Oct 1994 19:43:31 GMT","explode":false,"in":"header","name":"If-Modified-Since","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"The RFC7232 If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.","example":"Sat, 29 Oct 1994 19:43:31 GMT","explode":false,"in":"header","name":"If-Unmodified-Since","required":false,"schema":{"type":"string"},"style":"simple"},{"explode":true,"in":"query","name":"page","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"},{"explode":true,"in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandListResponse__Products-V3"}}},"description":"successful operation","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"}}},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read a list of known brands. This may be the case, if the user has not the necessary role."}},"summary":"List of allowed brands","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.otto.market/v3/products/brands?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'If-Match: 7da7a728f910' \\\n --header 'If-Modified-Since: Sat, 29 Oct 1994 19:43:31 GMT' \\\n --header 'If-None-Match: 7da7a728f910' \\\n --header 'If-Unmodified-Since: Sat, 29 Oct 1994 19:43:31 GMT'"},{"lang":"Shell + Httpie","source":"http GET 'https://api.otto.market/v3/products/brands?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN' \\\n If-Match:7da7a728f910 \\\n If-Modified-Since:'Sat, 29 Oct 1994 19:43:31 GMT' \\\n If-None-Match:7da7a728f910 \\\n If-Unmodified-Since:'Sat, 29 Oct 1994 19:43:31 GMT'"}]}},"/v3/products/categories":{"get":{"description":"Returns product categories and associated attributes of the OTTO market place. The total number of results could be limited by specifying query parameters. Generally the resulting product categories values will be paginated. The default page length is 100 product categories per response, the page size limit is 2000. The links specified in the result can be used to page through the total result space.","operationId":"Products-V3__getCategoryGroups","parameters":[{"description":"the number (starting with 0) of the page, that should be delivered.","explode":true,"in":"query","name":"page","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"proposed limit for the number of product categories per response page (at most 2000)","explode":true,"in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryGroups__Products-V3"}}},"description":"successful operation"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read the product categories. This may be the case, if the user has not the necessary role."}},"summary":"Read product categories","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.otto.market/v3/products/categories?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET 'https://api.otto.market/v3/products/categories?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v3/products/content-changes":{"get":{"description":"Read the content changes for all your product variations within a specific time period. You can also use this endpoint to read the content changes for more than one variation or if the sku value contains slash ('/') or dot ('.') characters, so that you cannot use the other endpoint with one dedicated sku value in the path. The resulting content changes will be paginated. The default page length is 100 entries per response, which also is the page size upper limit. The links specified in the result can be used to page through the total result space.","operationId":"Products-V3__getContentChanges2","parameters":[{"description":"search for product variations by their sku value. Use this to query for multiple variations or if your sku values contain slash ('/') or dot ('.') characters. You may separate multiple sku values by comma or state each one with a &sku= in front of the value. Please note that if you like to query for a single variation whose value contains a comma you have to add one empty &sku= at the end of the query string or use the other endpoint.","explode":true,"in":"query","name":"sku","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"search for content changes from this time on. The maxmimum and default value is 28 days before now. Future values can be specified, but lead to an empty result.","explode":true,"in":"query","name":"fromDate","required":false,"schema":{"format":"date-time","type":"string"},"style":"form"},{"explode":true,"in":"query","name":"page","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"proposed limit for the number of content changes per response page (at most 100)","explode":true,"in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentChangesApiResult__Products-V3"}}},"description":"successful operation"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read content changes of the specified product variations. This may be the case, if the user has not the necessary role."},"404":{"description":"The product variation with the specified sku value could not be found."}},"summary":"Read content changes within time period","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.otto.market/v3/products/content-changes?sku=SOME_ARRAY_VALUE&fromDate=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET 'https://api.otto.market/v3/products/content-changes?sku=SOME_ARRAY_VALUE&fromDate=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v3/products/marketplace-status":{"get":{"description":"The total number of results could be limited by specifying query parameters. Generally the resulting marketplace status will be paginated. The default page length is 100 product variations per response, also the page size limit. The links specified in the result can be used to page through the total result space.","operationId":"Products-V3__getMarketPlaceStatusList","parameters":[{"description":"search for product variations by their sku value. Use this if your sku values contain slash ('/') or dot ('.') characters.","explode":true,"in":"query","name":"sku","required":false,"schema":{"type":"string"},"style":"form"},{"description":"search marketplace status by the productReference value of the related product variations","explode":true,"in":"query","name":"productReference","required":false,"schema":{"type":"string"},"style":"form"},{"description":"search marketplace status by the category value of the related product variations","explode":true,"in":"query","name":"category","required":false,"schema":{"type":"string"},"style":"form"},{"description":"search marketplace status by the brand ID value of the related product variations","explode":true,"in":"query","name":"brandId","required":false,"schema":{"type":"string"},"style":"form"},{"description":"search marketplace status for a time range starting with the given date (in ISO8601, like '2021-10-09T07:52:19.820Z' or '2021-10-09T07:52:19.820+01:00')","explode":true,"in":"query","name":"fromDate","required":false,"schema":{"format":"date-time","type":"string"},"style":"form"},{"description":"page to load","explode":true,"in":"query","name":"page","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"proposed limit for the number of marketplace status per response page (at most 1000)","explode":true,"in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"only include items that match any of the provided status","explode":true,"in":"query","name":"marketPlaceStatus","required":false,"schema":{"items":{"enum":["PENDING","ONLINE","RESTRICTED","REJECTED","INACTIVE"],"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketPlaceStatusApiResult__Products-V3"}}},"description":"successful operation"},"304":{"description":"The request included an If-Modified-Since header, but the resource has not been modified since the specified date."},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read the specified marketplace status. This may be the case, if the user has not the necessary role."}},"summary":"Read marketplace status of product variations","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.otto.market/v3/products/marketplace-status?sku=SOME_STRING_VALUE&productReference=SOME_STRING_VALUE&category=SOME_STRING_VALUE&brandId=SOME_STRING_VALUE&fromDate=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&marketPlaceStatus=SOME_ARRAY_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET 'https://api.otto.market/v3/products/marketplace-status?sku=SOME_STRING_VALUE&productReference=SOME_STRING_VALUE&category=SOME_STRING_VALUE&brandId=SOME_STRING_VALUE&fromDate=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&marketPlaceStatus=SOME_ARRAY_VALUE' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v3/products/prices":{"get":{"description":"Read your product variations prices. The total number of results could be limited by specifying query parameters. Generally the resulting product variations will be paginated. The default page length is 100 product variations per response, also the page size limit. The links specified in the result can be used to page through the total result space.","operationId":"Products-V3__getProductVariationPrices","parameters":[{"description":"search for product variations by their sku value. Use this if your sku values contain slash ('/') or dot ('.') characters.","explode":true,"in":"query","name":"sku","required":false,"schema":{"type":"string"},"style":"form"},{"description":"search for product variations by their productReference value","explode":true,"in":"query","name":"productReference","required":false,"schema":{"type":"string"},"style":"form"},{"description":"search for product variations by their category value","explode":true,"in":"query","name":"category","required":false,"schema":{"type":"string"},"style":"form"},{"description":"search for product variations by their ID value","explode":true,"in":"query","name":"brandId","required":false,"schema":{"type":"string"},"style":"form"},{"explode":true,"in":"query","name":"page","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"proposed limit for the number of products per response page (at most 100)","explode":true,"in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceApiResult__Products-V3"}}},"description":"successful operation"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read the specified product variations prices. This may be the case, if the user has not the necessary role."}},"summary":"Read product variations prices","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.otto.market/v3/products/prices?sku=SOME_STRING_VALUE&productReference=SOME_STRING_VALUE&category=SOME_STRING_VALUE&brandId=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET 'https://api.otto.market/v3/products/prices?sku=SOME_STRING_VALUE&productReference=SOME_STRING_VALUE&category=SOME_STRING_VALUE&brandId=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]},"post":{"description":"Update your product variation prices and get a process-id to query results. The limit for the number of product variation prices in one request is 500.","operationId":"Products-V3__updateProductVariationPrices","parameters":[{"description":"Holds the optional client side update request timestamp, in ISO DateTime format","example":"2000-10-31T01:30:10.000-05:00","explode":false,"in":"header","name":"X-Request-Timestamp","required":false,"schema":{"format":"yyyy-MM-dd'T'HH:mm:ss.SSSXXX","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SkuPricing__Products-V3"},"type":"array"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductProcessProgress__Products-V3"}}},"description":"successful operation"},"202":{"description":"The request for a modification of the specified product variation prices was accepted and will be executed"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to modify the specified product variation prices. This may be the case, if the user has not the necessary role."}},"summary":"Update product variation prices","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.otto.market/v3/products/prices \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'X-Request-Timestamp: 2000-10-31T01:30:10.000-05:00' \\\n --header 'content-type: application/json' \\\n --data '[{\"sale\":{\"salePrice\":{\"amount\":19.95,\"currency\":\"EUR\"},\"endDate\":\"2019-10-19T09:30:00Z\",\"startDate\":\"2019-10-19T09:30:00Z\"},\"standardPrice\":{\"amount\":19.95,\"currency\":\"EUR\"},\"sku\":\"sku\"}]'"},{"lang":"Shell + Httpie","source":"echo '[{\"sale\":{\"salePrice\":{\"amount\":19.95,\"currency\":\"EUR\"},\"endDate\":\"2019-10-19T09:30:00Z\",\"startDate\":\"2019-10-19T09:30:00Z\"},\"standardPrice\":{\"amount\":19.95,\"currency\":\"EUR\"},\"sku\":\"sku\"}]' | \\\n http POST https://api.otto.market/v3/products/prices \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN' \\\n X-Request-Timestamp:2000-10-31T01:30:10.000-05:00 \\\n content-type:application/json"}]}},"/v3/products/update-tasks/{processUuid}":{"get":{"description":"The response will contain the links for the different parts of the result: products successfully created or updated, products with failures, products which did not contain any changes compared to the last sent version.","operationId":"Products-V3__progressByProcessId","parameters":[{"description":"search for a product data delivery result by its processUuid.","explode":false,"in":"path","name":"processUuid","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductProcessProgress__Products-V3"}}},"description":"successful operation"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read the specified product variations. This may be the case, if the user has not the necessary role."},"404":{"description":"The product data delivery results with the specified processUuid value could not be found."}},"summary":"Request the results of a product data delivery","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v3/products/update-tasks/%7BprocessUuid%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v3/products/update-tasks/%7BprocessUuid%7D \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v3/products/update-tasks/{processUuid}/failed":{"get":{"description":"Request the failed products of the product data delivery with the linked processUuid. The response will contain a list of failed products with associated error details.","operationId":"Products-V3__failedByProcessId","parameters":[{"description":"search for the failed products of a product data delivery identified by its processUuid.","explode":false,"in":"path","name":"processUuid","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductProcessResult__Products-V3"}}},"description":"successful operation"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read the specified product variations. This may be the case, if the user has not the necessary role."},"404":{"description":"The product data delivery results with the specified processUuid value could not be found."}},"summary":"List failed products of a product data delivery","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v3/products/update-tasks/%7BprocessUuid%7D/failed \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v3/products/update-tasks/%7BprocessUuid%7D/failed \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v3/products/update-tasks/{processUuid}/succeeded":{"get":{"description":"Request the succeeded products of the product data delivery with the linked processUuid. The response will contain a list of successfully delivered products.","operationId":"Products-V3__succeededByProcessId","parameters":[{"description":"search for the succeeded products of a product data delivery identified by its processUuid.","explode":false,"in":"path","name":"processUuid","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductProcessResult__Products-V3"}}},"description":"successful operation"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read the specified product variations. This may be the case, if the user has not the necessary role."},"404":{"description":"The product data delivery results with the specified processUuid value could not be found."}},"summary":"List succeeded products of a product data delivery","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v3/products/update-tasks/%7BprocessUuid%7D/succeeded \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v3/products/update-tasks/%7BprocessUuid%7D/succeeded \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v3/products/update-tasks/{processUuid}/unchanged":{"get":{"description":"Request the unchanged products of the product data delivery with the linked processUuid. The response will contain a list of unchanged products.","operationId":"Products-V3__unchangedByProcessId","parameters":[{"description":"search for the unchanged products of a product data delivery identified by its processUuid.","explode":false,"in":"path","name":"processUuid","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductProcessResult__Products-V3"}}},"description":"successful operation"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read the specified product variations. This may be the case, if the user has not the necessary role."},"404":{"description":"The product data delivery results with the specified processUuid value could not be found."}},"summary":"List unchanged products of a product data delivery","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v3/products/update-tasks/%7BprocessUuid%7D/unchanged \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v3/products/update-tasks/%7BprocessUuid%7D/unchanged \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v3/products/{sku}":{"get":{"description":"Returns a single product variation by SKU.","operationId":"Products-V3__getProductVariation","parameters":[{"description":"search for a product variation by its SKU value","explode":false,"in":"path","name":"sku","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVariation__Products-V3"}}},"description":"successful operation"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read the specified product variations. This may be the case, if the user has not the necessary role."},"404":{"description":"The product variation with the specified sku value could not be found."}},"summary":"Read a single product variation","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v3/products/%7Bsku%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v3/products/%7Bsku%7D \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v3/products/{sku}/active-status":{"get":{"description":"Returns active status of the requested product variation by SKU.","operationId":"Products-V3__getVariationActiveStatus","parameters":[{"description":"search for a product variation by its SKU value","explode":false,"in":"path","name":"sku","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveStatus__Products-V3"}}},"description":"successful operation"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read the active status of the specified product variations. This may be the case, if the user has not the necessary role."},"404":{"description":"The product variation with the specified sku value could not be found."}},"summary":"Read the active status of a single product variation","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v3/products/%7Bsku%7D/active-status \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v3/products/%7Bsku%7D/active-status \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v3/products/{sku}/content-changes":{"get":{"description":"Returns the content changes info for a single product variation within a specific time period. The resulting content changes will be paginated. The default page length is 100 entries per response, also the page size limit. The links specified in the result can be used to page through the total result space.","operationId":"Products-V3__getContentChanges","parameters":[{"description":"search for a product variation by its SKU value","explode":false,"in":"path","name":"sku","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"search for content changes from this time on. The maxmimum and default value is 28 days before now. Future values can be specified, but lead to an empty result.","explode":true,"in":"query","name":"fromDate","required":false,"schema":{"format":"date-time","type":"string"},"style":"form"},{"explode":true,"in":"query","name":"page","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"proposed limit for the number of entries per response page (at most 100)","explode":true,"in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentChangesApiResult__Products-V3"}}},"description":"successful operation"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read the content changes of the specified product variations. This may be the case, if the user has not the necessary role."},"404":{"description":"The product variation with the specified sku value could not be found."}},"summary":"Read content changes for a single product variation","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.otto.market/v3/products/%7Bsku%7D/content-changes?fromDate=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET 'https://api.otto.market/v3/products/%7Bsku%7D/content-changes?fromDate=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v3/products/{sku}/marketplace-status":{"get":{"description":"Returns marketplace status for a single product variation by SKU.","operationId":"Products-V3__getMarketPlaceStatus","parameters":[{"description":"search for a marketplace status by its SKU value","explode":false,"in":"path","name":"sku","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketPlaceStatus__Products-V3"}}},"description":"successful operation"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read the specified marketplace status. This may be the case, if the user has not the necessary role."},"404":{"description":"The product variation with the specified sku value could not be found."}},"summary":"Read marketplace status for a single product variation","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v3/products/%7Bsku%7D/marketplace-status \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v3/products/%7Bsku%7D/marketplace-status \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v3/products/{sku}/prices":{"get":{"description":"Read the price data of a single product variation.","operationId":"Products-V3__getProductVariationPrice","parameters":[{"description":"search for a product variation by its SKU value","explode":false,"in":"path","name":"sku","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkuPricing__Products-V3"}}},"description":"successful operation"},"401":{"description":"The technical user could not be authenticated"},"403":{"description":"The technical user is not authorized to read the specified product variations. This may be the case, if the user has not the necessary role."},"404":{"description":"The product variation with the specified sku value could not be found."}},"summary":"Read a single product variation price","tags":["Products-V3"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v3/products/%7Bsku%7D/prices \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v3/products/%7Bsku%7D/prices \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v2/quantities":{"post":{"tags":["Quantities-V2"],"summary":"Update the available quantity for a specific SKU (up to 200 SKUs per request) ","operationId":"Quantities-V2__storeAvailableQuantitiesUsingPOST","requestBody":{"content":{"application/json;charset=UTF-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AvailableQuantityRequestDTOV2__Quantities-V2"}}}},"description":"availableQuantityRequestDTO","required":true},"responses":{"200":{"description":"Ok","content":{"application/json;charset=UTF-8":{"schema":{"type":"object"}}}},"207":{"description":"Multi Status (SKUs is unknown | Quantity must be >= 0 | Field must not be empty)","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/UpdateQuantityMultiStatusResponse__Quantities-V2"}}}},"400":{"description":"Bad Request (Turned off Host in Header)","content":{"text/html":{"examples":{"Bad Request":{"value":" 400 Bad Request

400 Bad Request

"}}}}},"401":{"description":"Unauthorized to access"},"403":{"description":"Forbidden (Invalid token)","content":{"application/json":{"examples":{"Token is invalid":{"value":{"message":"Forbidden"}}}}}},"404":{"description":"Not found (URL is invalid)","content":{"application/json":{"examples":{"URL is invalid":{"value":{"message":"Not Found"}}}}}},"413":{"description":"Payload too large","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/PayloadTooLargeApiErrorResponseV2__Quantities-V2"}}}},"422":{"description":"Non-processable (SKUs is unknown | Quantity must be >= 0 | Field must not be empty | Invalid Quantity: Can only accept whole numbers)","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseV2__Quantities-V2"}}}}},"deprecated":false,"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.otto.market/v2/quantities \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http POST https://api.otto.market/v2/quantities \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]},"get":{"tags":["Quantities-V2"],"summary":"Get available quantities for a specific Partner (Upto 200 per request).","description":"Retrieve available quantities sorted by sku name in ascending.The maximum number of returned quantities is limited to 200.","operationId":"Quantities-V2__getAvailableQuantities","parameters":[{"name":"limit","in":"query","description":"The maximum number of available quantities to be returned in each response.","required":false,"schema":{"type":"integer","format":"int32","default":200}},{"name":"page","in":"query","description":"Page number (0..N)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"cursor","in":"query","description":"Cursor for paging requests. If a cursor is provided, the only other request parameter being considered is 'limit'. The cursor value is the last evaluted sku in the request response (Needs to be a valid sku value)","required":false,"schema":{"type":"string","example":"c2t1NDM="}}],"responses":{"200":{"description":"Ok","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/AvailableQuantityResponseV2__Quantities-V2"}}}},"400":{"description":"Limit and page need to be integers","content":{"application/json":{"examples":{"Bad request":{"summary":"Response for invalid requests","description":"BAD REQUEST","value":{"errors":[{"code":400,"detail":"Limit and page need to be valid integers","path":"/v2/quantities","title":"BAD REQUEST","logreg":""}]}}}}}},"403":{"description":"Unauthorized to access","content":{"application/json":{"examples":{"Bad request":{"summary":"Response for invalid requests","description":"FORBIDDEN","value":{"errors":[{"code":403,"detail":"User is unauthorised to perform this action","path":"/v2/quantities","title":"Access Forbidden","logreg":""}]}}}}}},"404":{"description":"Not found (URL is invalid)","content":{"application/json":{"examples":{"URL is invalid":{"value":{"message":"Not Found"}}}}}}},"deprecated":false,"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.otto.market/v2/quantities?limit=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&cursor=c2t1NDM%3D' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET 'https://api.otto.market/v2/quantities?limit=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&cursor=c2t1NDM%3D' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v2/quantities/{sku}":{"get":{"tags":["Quantities-V2"],"summary":"Get available quantity for a specific Sku","description":"Fetch a single available quantity by its unique sku name.","operationId":"Quantities-V2__getAvailableQuantityBySku","parameters":[{"name":"sku","in":"path","required":true,"description":"The sku for the available quantity","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/AvailableQuantitySingleResponseDTOV2__Quantities-V2"}}}},"400":{"description":"Bad Request (Turned off Host in Header)","content":{"text/html":{"examples":{"Bad Request":{"value":" 400 Bad Request

400 Bad Request

"}}}}},"403":{"description":"Unauthorized to access","content":{"application/json":{"examples":{"Bad request":{"summary":"Response for invalid requests","description":"FORBIDDEN","value":{"errors":[{"code":403,"detail":"User is unauthorised to perform this action","path":"/v2/quantities","title":"Access Forbidden","logreg":""}]}}}}}},"404":{"description":"Requested sku was unknown (send a quantity update for the product before trying to retrieve it)","content":{"application/json":{"examples":{"Bad request":{"summary":"Requested sku was unknown","description":"NOT FOUND","value":{"errors":[{"code":404,"detail":"No record found for requested sku","path":"/v2/quantities/{sku}","title":"NOT FOUND","logreg":""}]}}}}}}},"deprecated":false,"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v2/quantities/%7Bsku%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v2/quantities/%7Bsku%7D \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v4/orders":{"get":{"description":"Retrieve orders sorted by order date from oldest to newest. The number of returned orders is limited to 128; cursor based pagination is supported.","operationId":"Orders-V4__findPartnerOrders","parameters":[{"description":"Defines earliest change date (ISO 8601) the returned orders should have","example":"2019-08-01T01:00:00+02:00","in":"query","name":"fromDate","required":false,"schema":{"type":"string","example":null}},{"description":"Only orders newer than the date specified (ISO 8601) will be returned","example":"2020-07-01T00:00:00+02:00","in":"query","name":"fromOrderDate","required":false,"schema":{"type":"string","example":null}},{"description":"Only orders older than the date specified (ISO 8601) will be returned","example":"2020-07-01T23:59:59+02:00","in":"query","name":"toOrderDate","required":false,"schema":{"type":"string","example":null}},{"description":"
ANNOUNCED: Orders with at least one position item in state ANNOUNCED
PROCESSABLE: Orders with at least one position item in state PROCESSABLE and none in ANNOUNCED
SENT: Orders with at least one position item in state SENT and none in either ANNOUNCED or PROCESSABLE
RETURNED: Orders with at least one position item in state RETURNED and none in either ANNOUNCED, PROCESSABLE, or SENT
CANCELLED_BY_PARTNER: Orders with at least one position item in state CANCELLED_BY_PARTNER
CANCELLED_BY_MARKETPLACE: Orders with at least one position item in state CANCELLED_BY_MARKETPLACE

If no state is provided, orders in all possible states are returned.
Several values can be passed; it will return a combination of these states without duplicates.
Also see parameter 'mode'.","example":"PROCESSABLE&fulfillmentStatus=CANCELLED_BY_MARKETPLACE","in":"query","name":"fulfillmentStatus","required":false,"schema":{"type":"string","enum":["ANNOUNCED","PROCESSABLE","SENT","RETURNED","CANCELLED_BY_PARTNER","CANCELLED_BY_MARKETPLACE"],"example":null},"style":"form"},{"description":"The maximum amount of orders to return","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int32","default":128,"example":null}},{"description":"Sort result by 'orderColumnType' in ASCending or DESCending order","in":"query","name":"orderDirection","required":false,"schema":{"type":"string","default":"ASC","enum":["ASC","DESC"],"example":null}},{"description":"The column on which to apply 'orderDirection' parameter","in":"query","name":"orderColumnType","required":false,"schema":{"type":"string","default":"ORDER_LIFECYCLE_DATE","enum":["ORDER_DATE","ORDER_LIFECYCLE_DATE","LAST_MODIFIED_DATE","EXPECTED_DELIVERY_DATE"],"example":null}},{"description":"In search mode AT_LEAST_ONE orders with at least one position item in given 'fulfillmentStatus' will always be returned","in":"query","name":"mode","required":false,"schema":{"type":"string","default":"BUCKET","enum":["BUCKET","AT_LEAST_ONE"],"example":null}},{"description":"Cursor for paging requests. If a next cursor is provided, the only other request parameter being considered is 'limit'

Note: Only the cursor string is required - not the whole link","example":"eyJmZiI6MTU5NDg5NDQ3MTA1OCwicGlmIjoiNDcxM","in":"query","name":"nextcursor","required":false,"schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"examples":{"List of orders":{"description":"List of orders","summary":"List of orders","value":{"resources":[{"salesOrderId":"8bd8a7cb-1ce1-4024-bdec-1c60de3c8006","orderNumber":"bwvdp9gcyk","orderDate":"2021-03-31T09:45:52.313+0000","lastModifiedDate":"2021-03-31T10:30:52.434+0000","positionItems":[{"positionItemId":"41d73c45-6177-4230-8907-4ffafd09064e","fulfillmentStatus":"ANNOUNCED","itemValueGrossPrice":{"amount":13.37,"currency":"EUR"},"product":{"sku":"P4567","productTitle":"Red T-Shirt","articleNumber":"X2G1D12FT8","ean":"4606938545083","vatRate":19}}],"orderLifecycleInformation":{"lifecycleChangeDate":"2021-03-31T10:30:52.433+0000"},"payment":{"paymentMethod":"PREPAYMENT"},"initialDeliveryFees":[{"name":"DELIVERY_FEE_STANDARD","deliveryFeeAmount":{"amount":5.95,"currency":"EUR"},"positionItemIds":["41d73c45-6177-4230-8907-4ffafd09064e"],"vatRate":19}],"links":[{"rel":"self","href":"/v4/orders/8bd8a7cb-1ce1-4024-bdec-1c60de3c8006"}]},{"salesOrderId":"02807492-35b8-46a1-9493-ac34ba006da0","orderNumber":"cwvcp4gvyy","orderDate":"2021-04-15T12:19:49.007+0000","lastModifiedDate":"2021-04-15T13:04:51.121+0000","positionItems":[{"positionItemId":"50606ce0-fb36-47af-b5f2-30e18da115b4","fulfillmentStatus":"ANNOUNCED","itemValueGrossPrice":{"amount":11.49,"currency":"EUR"},"product":{"sku":"T7781","productTitle":"Blue Socks","articleNumber":"Y7G1D73GH1","vatRate":19}}],"orderLifecycleInformation":{"lifecycleChangeDate":"2021-04-15T13:04:51.112+0000"},"payment":{"paymentMethod":"PREPAYMENT"},"initialDeliveryFees":[{"name":"DELIVERY_FEE_STANDARD","deliveryFeeAmount":{"amount":5.95,"currency":"EUR"},"positionItemIds":["50606ce0-fb36-47af-b5f2-30e18da115b4"],"vatRate":19}],"links":[{"rel":"self","href":"/v4/orders/02807492-35b8-46a1-9493-ac34ba006da0"}]}],"links":[{"rel":"next","href":"/v4/orders?nextcursor=QlVDS0VUOjE1NjgyMjAwNDg2MTM6NDcxMTpBTk5PVU5DRUQ6&limit=128"}]}}},"schema":{"$ref":"#/components/schemas/PartnerOrderList__Orders-V4"}}},"description":"Successfully retrieved sales orders"},"400":{"content":{"application/json":{"examples":{"Bad request":{"description":"Bad request","summary":"Response for invalid requests","value":{"errors":[{"path":"/v4/orders/...","title":"Bad Request","detail":"Cannot parse request - please check query parameters and/or body"}]}}}}},"description":"Request is invalid"},"401":{"content":{"application/json":{"examples":{"Auth failed":{"description":"Auth failed","summary":"Response for invalid credentials","value":{"errors":[{"path":"/v4/orders/...","title":"Unauthorized","detail":"No proper credentials were provided"}]}}}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"examples":{"Authorization missing":{"description":"Authorization missing","summary":"Response for missing access role rights","value":{"errors":[{"path":"/v4/orders/...","title":"Forbidden","detail":"No permission to access specified resource(s)"}]}}}}},"description":"Forbidden"}},"summary":"List of orders filtered by fulfillment state","tags":["Orders-V4"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.otto.market/v4/orders?fromDate=2019-08-01T01%3A00%3A00%2B02%3A00&fromOrderDate=2020-07-01T00%3A00%3A00%2B02%3A00&toOrderDate=2020-07-01T23%3A59%3A59%2B02%3A00&fulfillmentStatus=PROCESSABLE%26fulfillmentStatus%3DCANCELLED_BY_MARKETPLACE&limit=null&orderDirection=null&orderColumnType=null&mode=null&nextcursor=eyJmZiI6MTU5NDg5NDQ3MTA1OCwicGlmIjoiNDcxM' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET 'https://api.otto.market/v4/orders?fromDate=2019-08-01T01%3A00%3A00%2B02%3A00&fromOrderDate=2020-07-01T00%3A00%3A00%2B02%3A00&toOrderDate=2020-07-01T23%3A59%3A59%2B02%3A00&fulfillmentStatus=PROCESSABLE%26fulfillmentStatus%3DCANCELLED_BY_MARKETPLACE&limit=null&orderDirection=null&orderColumnType=null&mode=null&nextcursor=eyJmZiI6MTU5NDg5NDQ3MTA1OCwicGlmIjoiNDcxM' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v4/orders/{orderNumber}":{"get":{"description":"Fetch a single order by its unique order number.","operationId":"Orders-V4__getPartnerOrderByOrderNumber","parameters":[{"in":"path","name":"orderNumber","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"examples":{"Announced order":{"description":"Announced order","summary":"An order in state ANNOUNCED","value":{"salesOrderId":"8bd8a7cb-1ce1-4024-bdec-1c60de3c8006","orderNumber":"bwvdp9gcyk","orderDate":"2021-03-31T09:45:52.313+0000","lastModifiedDate":"2021-03-31T10:30:52.434+0000","positionItems":[{"positionItemId":"41d73c45-6177-4230-8907-4ffafd09064e","fulfillmentStatus":"ANNOUNCED","itemValueGrossPrice":{"amount":13.37,"currency":"EUR"},"product":{"sku":"P4567","productTitle":"Red T-Shirt","articleNumber":"X2G1D12FT8","ean":"4606938545083","vatRate":19}}],"orderLifecycleInformation":{"lifecycleChangeDate":"2021-03-31T10:30:52.433+0000"},"payment":{"paymentMethod":"PREPAYMENT"},"initialDeliveryFees":[{"name":"DELIVERY_FEE_STANDARD","deliveryFeeAmount":{"amount":5.95,"currency":"EUR"},"positionItemIds":["41d73c45-6177-4230-8907-4ffafd09064e"],"vatRate":19}],"links":[{"rel":"self","href":"/v4/orders/8bd8a7cb-1ce1-4024-bdec-1c60de3c8006"}]}},"Processable order":{"description":"Processable order","summary":"An order in state PROCESSABLE","value":{"salesOrderId":"a24c37c0-768f-44e6-9f5c-1e4430d4ab32","orderNumber":"bwqwz7s8cx","orderDate":"2021-04-16T05:59:01.255+0000","lastModifiedDate":"2021-04-16T06:44:02.249+0000","positionItems":[{"positionItemId":"8a88e387-a03d-4cc9-99d9-3de6a5c038bd","fulfillmentStatus":"PROCESSABLE","expectedDeliveryDate":"2021-04-21T12:00:00.000+02:00","itemValueGrossPrice":{"amount":23.95,"currency":"EUR"},"product":{"sku":"V0533","productTitle":"White Shirt","articleNumber":"1563237W3","vatRate":19}},{"positionItemId":"43111eca-18e5-4fe4-846c-2009d3643495","fulfillmentStatus":"CANCELLED_BY_PARTNER","expectedDeliveryDate":"2021-04-21T12:00:00.000+02:00","cancellationReason":"CANCELLED_ON_PARTNER_WISH","itemValueGrossPrice":{"amount":99.2,"currency":"EUR"},"product":{"sku":"A7567","productTitle":"Black Jeans","articleNumber":"333207J4","vatRate":19}},{"positionItemId":"e4b96f70-495a-423c-877e-8886b5532ba4","fulfillmentStatus":"PROCESSABLE","expectedDeliveryDate":"2021-04-24T12:00:00.000+02:00","itemValueGrossPrice":{"amount":15.7,"currency":"EUR"},"product":{"sku":"L8456","productTitle":"Red Socks","articleNumber":"4561237P3","vatRate":19}}],"orderLifecycleInformation":{"lifecycleChangeDate":"2021-04-16T06:44:02.249+0000"},"payment":{"paymentMethod":"PREPAYMENT"},"initialDeliveryFees":[{"name":"DELIVERY_FEE_STANDARD","deliveryFeeAmount":{"amount":5.95,"currency":"EUR"},"positionItemIds":["8a88e387-a03d-4cc9-99d9-3de6a5c038bd","43111eca-18e5-4fe4-846c-2009d3643495","e4b96f70-495a-423c-877e-8886b5532ba4"],"vatRate":19}],"deliveryAddress":{"salutation":"MS","title":"Dr.","lastName":"Mustermann","firstName":"Max","street":"Werner-Otto-Str.","addition":"Hinterm Haus","houseNumber":"960","city":"Hamburg","zipCode":"22179","countryCode":"DEU","phoneNumber":"040 12345678","email":"test@example.com"},"invoiceAddress":{"salutation":"MS","title":"Dr.","lastName":"Mustermann","firstName":"Max","street":"Werner-Otto-Str.","addition":"Hinterm Haus","houseNumber":"960","city":"Hamburg","zipCode":"22179","countryCode":"DEU"},"links":[{"rel":"self","href":"/v4/orders/a24c37c0-768f-44e6-9f5c-1e4430d4ab32"}]}}},"schema":{"$ref":"#/components/schemas/PartnerOrder__Orders-V4"}}},"description":"Successfully found the requested sales order"},"400":{"content":{"application/json":{"examples":{"Bad request":{"description":"Bad request","summary":"Response for invalid requests","value":{"errors":[{"path":"/v4/orders/...","title":"Bad Request","detail":"Cannot parse request - please check query parameters and/or body"}]}}}}},"description":"Request is invalid"},"401":{"content":{"application/json":{"examples":{"Auth failed":{"description":"Auth failed","summary":"Response for invalid credentials","value":{"errors":[{"path":"/v4/orders/...","title":"Unauthorized","detail":"No proper credentials were provided"}]}}}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"examples":{"Authorization missing":{"description":"Authorization missing","summary":"Response for missing access role rights","value":{"errors":[{"path":"/v4/orders/...","title":"Forbidden","detail":"No permission to access specified resource(s)"}]}}}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"Not found":{"description":"Not found","summary":"Resource 'Not Found' response","value":{"errors":[{"path":"/v4/orders/...","title":"Not Found","detail":"The specified resource(s) could not be found"}]}}}}},"description":"Order with given orderNumber not found"}},"summary":"Get an order via order number","tags":["Orders-V4"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v4/orders/null \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v4/orders/null \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v4/orders/{salesOrderId}":{"get":{"description":"Fetch a single order by its unique sales order id.","operationId":"Orders-V4__getPartnerOrderBySalesOrderId","parameters":[{"in":"path","name":"salesOrderId","required":true,"schema":{"type":"string","example":null}}],"responses":{"200":{"content":{"application/json":{"examples":{"Announced order":{"description":"Announced order","summary":"An order in state ANNOUNCED","value":{"salesOrderId":"8bd8a7cb-1ce1-4024-bdec-1c60de3c8006","orderNumber":"bwvdp9gcyk","orderDate":"2021-03-31T09:45:52.313+0000","lastModifiedDate":"2021-03-31T10:30:52.434+0000","positionItems":[{"positionItemId":"41d73c45-6177-4230-8907-4ffafd09064e","fulfillmentStatus":"ANNOUNCED","itemValueGrossPrice":{"amount":13.37,"currency":"EUR"},"product":{"sku":"P4567","productTitle":"Red T-Shirt","articleNumber":"X2G1D12FT8","ean":"4606938545083","vatRate":19}}],"orderLifecycleInformation":{"lifecycleChangeDate":"2021-03-31T10:30:52.433+0000"},"payment":{"paymentMethod":"PREPAYMENT"},"initialDeliveryFees":[{"name":"DELIVERY_FEE_STANDARD","deliveryFeeAmount":{"amount":5.95,"currency":"EUR"},"positionItemIds":["41d73c45-6177-4230-8907-4ffafd09064e"],"vatRate":19}],"links":[{"rel":"self","href":"/v4/orders/8bd8a7cb-1ce1-4024-bdec-1c60de3c8006"}]}},"Processable order":{"description":"Processable order","summary":"An order in state PROCESSABLE","value":{"salesOrderId":"a24c37c0-768f-44e6-9f5c-1e4430d4ab32","orderNumber":"bwqwz7s8cx","orderDate":"2021-04-16T05:59:01.255+0000","lastModifiedDate":"2021-04-16T06:44:02.249+0000","positionItems":[{"positionItemId":"8a88e387-a03d-4cc9-99d9-3de6a5c038bd","fulfillmentStatus":"PROCESSABLE","expectedDeliveryDate":"2021-04-21T12:00:00.000+02:00","itemValueGrossPrice":{"amount":23.95,"currency":"EUR"},"product":{"sku":"V0533","productTitle":"White Shirt","articleNumber":"1563237W3","vatRate":19}},{"positionItemId":"43111eca-18e5-4fe4-846c-2009d3643495","fulfillmentStatus":"CANCELLED_BY_PARTNER","expectedDeliveryDate":"2021-04-21T12:00:00.000+02:00","cancellationReason":"CANCELLED_ON_PARTNER_WISH","itemValueGrossPrice":{"amount":99.2,"currency":"EUR"},"product":{"sku":"A7567","productTitle":"Black Jeans","articleNumber":"333207J4","vatRate":19}},{"positionItemId":"e4b96f70-495a-423c-877e-8886b5532ba4","fulfillmentStatus":"PROCESSABLE","expectedDeliveryDate":"2021-04-24T12:00:00.000+02:00","itemValueGrossPrice":{"amount":15.7,"currency":"EUR"},"product":{"sku":"L8456","productTitle":"Red Socks","articleNumber":"4561237P3","vatRate":19}}],"orderLifecycleInformation":{"lifecycleChangeDate":"2021-04-16T06:44:02.249+0000"},"payment":{"paymentMethod":"PREPAYMENT"},"initialDeliveryFees":[{"name":"DELIVERY_FEE_STANDARD","deliveryFeeAmount":{"amount":5.95,"currency":"EUR"},"positionItemIds":["8a88e387-a03d-4cc9-99d9-3de6a5c038bd","43111eca-18e5-4fe4-846c-2009d3643495","e4b96f70-495a-423c-877e-8886b5532ba4"],"vatRate":19}],"deliveryAddress":{"salutation":"MS","title":"Dr.","lastName":"Mustermann","firstName":"Max","street":"Werner-Otto-Str.","addition":"Hinterm Haus","houseNumber":"960","city":"Hamburg","zipCode":"22179","countryCode":"DEU","phoneNumber":"040 12345678","email":"test@example.com"},"invoiceAddress":{"salutation":"MS","title":"Dr.","lastName":"Mustermann","firstName":"Max","street":"Werner-Otto-Str.","addition":"Hinterm Haus","houseNumber":"960","city":"Hamburg","zipCode":"22179","countryCode":"DEU"},"links":[{"rel":"self","href":"/v4/orders/a24c37c0-768f-44e6-9f5c-1e4430d4ab32"}]}}},"schema":{"$ref":"#/components/schemas/PartnerOrder__Orders-V4"}}},"description":"Successfully found the requested sales order"},"400":{"content":{"application/json":{"examples":{"Bad request":{"description":"Bad request","summary":"Response for invalid requests","value":{"errors":[{"path":"/v4/orders/...","title":"Bad Request","detail":"Cannot parse request - please check query parameters and/or body"}]}}}}},"description":"Request is invalid"},"401":{"content":{"application/json":{"examples":{"Auth failed":{"description":"Auth failed","summary":"Response for invalid credentials","value":{"errors":[{"path":"/v4/orders/...","title":"Unauthorized","detail":"No proper credentials were provided"}]}}}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"examples":{"Authorization missing":{"description":"Authorization missing","summary":"Response for missing access role rights","value":{"errors":[{"path":"/v4/orders/...","title":"Forbidden","detail":"No permission to access specified resource(s)"}]}}}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"Not found":{"description":"Not found","summary":"Resource 'Not Found' response","value":{"errors":[{"path":"/v4/orders/...","title":"Not Found","detail":"The specified resource(s) could not be found"}]}}}}},"description":"Order with given salesOrderId not found"}},"summary":"Get an order via sales order id","tags":["Orders-V4"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v4/orders/null \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v4/orders/null \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v4/orders/{salesOrderId}/cancellation":{"post":{"description":"Allows to cancel all position items of one or more orders by salesOrderId.
Note: Only position items in state PROCESSABLE can be cancelled. Position items in different states will be ignored. If no position item can be cancelled the operation will respond with a conflict error message.","operationId":"Orders-V4__cancelPartnerOrders","parameters":[{"description":"The salesOrderIds of the orders to cancel","in":"path","name":"salesOrderId","required":true,"schema":{"type":"array","example":null,"items":{"type":"string","example":null}}}],"responses":{"202":{"description":"The request was accepted - update will be processed asynchronously"},"400":{"content":{"application/json":{"examples":{"Bad request":{"description":"Bad request","summary":"Response for invalid requests","value":{"errors":[{"path":"/v4/orders/...","title":"Bad Request","detail":"Cannot parse request - please check query parameters and/or body"}]}}}}},"description":"Request is invalid"},"401":{"content":{"application/json":{"examples":{"Auth failed":{"description":"Auth failed","summary":"Response for invalid credentials","value":{"errors":[{"path":"/v4/orders/...","title":"Unauthorized","detail":"No proper credentials were provided"}]}}}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"examples":{"Authorization missing":{"description":"Authorization missing","summary":"Response for missing access role rights","value":{"errors":[{"path":"/v4/orders/...","title":"Forbidden","detail":"No permission to access specified resource(s)"}]}}}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"Not found":{"description":"Not found","summary":"Resource 'Not Found' response","value":{"errors":[{"path":"/v4/orders/...","title":"Not Found","detail":"The specified resource(s) could not be found"}]}}}}},"description":"At least one of the given salesOrderIds is unknown"},"409":{"content":{"application/json":{"example":{"errors":[{"path":"/v4/orders/9404a8e2-8203-43de-889d-b5d733b6698f/cancellation","title":"Conflict","detail":"No position item in sales order [9404a8e2-8203-43de-889d-b5d733b6698f] has a fulfillment status that can be changed to [CANCELLED_BY_PARTNER]. Fulfillment status needs to be [PROCESSABLE]."}]}}},"description":"There was a conflict while trying to cancel"}},"summary":"Cancel all position items of an order","tags":["Orders-V4"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.otto.market/v4/orders/null/cancellation \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http POST https://api.otto.market/v4/orders/null/cancellation \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v4/orders/{salesOrderId}/positionItems/{positionItemIds}/cancellation":{"post":{"description":"Allows to cancel specific position items of an order by salesOrderId and positionItemIds.
Note: Only position items in state PROCESSABLE can be cancelled. Position items in state CANCELLED_BY_PARTNER will be ignored. If any position item is in a different state the operation will leave the whole order unchanged and respond with a conflict error message.","operationId":"Orders-V4__cancelPartnerOrderPositionItems","parameters":[{"description":"The salesOrderId of the order","in":"path","name":"salesOrderId","required":true,"schema":{"type":"string","example":null}},{"description":"The positionItemIds of the order to cancel","in":"path","name":"positionItemIds","required":true,"schema":{"type":"array","example":null,"items":{"type":"string","example":null}}}],"responses":{"202":{"description":"The request was accepted - update will be processed asynchronously"},"400":{"content":{"application/json":{"examples":{"Bad request":{"description":"Bad request","summary":"Response for invalid requests","value":{"errors":[{"path":"/v4/orders/...","title":"Bad Request","detail":"Cannot parse request - please check query parameters and/or body"}]}}}}},"description":"Request is invalid"},"401":{"content":{"application/json":{"examples":{"Auth failed":{"description":"Auth failed","summary":"Response for invalid credentials","value":{"errors":[{"path":"/v4/orders/...","title":"Unauthorized","detail":"No proper credentials were provided"}]}}}}},"description":"Authentication failed"},"403":{"content":{"application/json":{"examples":{"Authorization missing":{"description":"Authorization missing","summary":"Response for missing access role rights","value":{"errors":[{"path":"/v4/orders/...","title":"Forbidden","detail":"No permission to access specified resource(s)"}]}}}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"Not found":{"description":"Not found","summary":"Resource 'Not Found' response","value":{"errors":[{"path":"/v4/orders/...","title":"Not Found","detail":"The specified resource(s) could not be found"}]}}}}},"description":"Order with given salesOrderId not found or order did not contain one of the given positionItemIds"},"409":{"content":{"application/json":{"example":{"errors":[{"path":"/v4/orders/9404a8e2-8203-43de-889d-b5d733b6698f/positionItems/ac50ec7f-0e0a-404f-a06d-524cfc2374ba/cancellation","title":"Conflict","detail":"Fulfillment status of position item [ac50ec7f-0e0a-404f-a06d-524cfc2374ba] in sales order [9404a8e2-8203-43de-889d-b5d733b6698f] can't be changed from [ANNOUNCED] to [CANCELLED_BY_PARTNER]. Fulfillment status needs to be [PROCESSABLE]."}]}}},"description":"There was a conflict while trying to cancel"}},"summary":"Cancel specific position items of an order","tags":["Orders-V4"],"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.otto.market/v4/orders/null/positionItems/null/cancellation \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http POST https://api.otto.market/v4/orders/null/positionItems/null/cancellation \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v1/return-shipments":{"get":{"tags":["ReturnShipments-V1"],"summary":"Retrieve returnShipments.","description":"This endpoint can be used to retrieve the returned shipments for a given authorized partner.","operationId":"ReturnShipments-V1__listReturnShipmentsUsingGET","parameters":[{"name":"datefrom","description":"ReturnShipments which are announced after this date or had an status update after this date will be returned for the partner which is determined from the authorization token. The date is considered as UTC.","in":"query","required":true,"allowEmptyValue":false,"schema":{"type":"string","format":"date-time"}},{"name":"limit","in":"query","description":"The maximum number of returnShipments to be returned in each response.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":25}},{"name":"next","in":"query","description":"The cursor which points to the next returnShipment that should be queried. It is used to paginate the results.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnShipmentList__ReturnShipments-V1"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized__ReturnShipments-V1"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorGetReturnShipmentList__ReturnShipments-V1"}}}}},"deprecated":false,"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.otto.market/v1/return-shipments?datefrom=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&next=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET 'https://api.otto.market/v1/return-shipments?datefrom=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&next=SOME_STRING_VALUE' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v1/return-shipments/carriers/{carrier}/trackingnumbers/{trackingNumber}":{"get":{"tags":["ReturnShipments-V1"],"summary":"Retrieve returnShipment by carrier and tracking number.","description":"This endpoint can be used to retrieve a returned shipment by carrier and tracking number.","operationId":"ReturnShipments-V1__returnShipmentByCarrierAndTrackingNumberUsingGET","parameters":[{"name":"carrier","in":"path","description":"The carrier of the returnShipment.","required":true,"schema":{"type":"string","enum":["DHL","GLS","HERMES","HES"]}},{"name":"trackingNumber","in":"path","description":"The tracking number of the returnShipment assigned by the carrier.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnShipment__ReturnShipments-V1"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized__ReturnShipments-V1"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenGetReturnShipmentByTrackingNumber__ReturnShipments-V1"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundGetReturnShipmentByTrackingNumber__ReturnShipments-V1"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorGetReturnShipmentByTrackingNumber__ReturnShipments-V1"}}}}},"deprecated":false,"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v1/return-shipments/carriers/%7Bcarrier%7D/trackingnumbers/%7BtrackingNumber%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v1/return-shipments/carriers/%7Bcarrier%7D/trackingnumbers/%7BtrackingNumber%7D \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v1/return-shipments/{returnShipmentId}":{"get":{"tags":["ReturnShipments-V1"],"summary":"Retrieve returnShipments by returnShipment ID.","description":"This endpoint can be used to retrieve a returned shipment by OTTO internal returnShipment ID.","operationId":"ReturnShipments-V1__returnShipmentUsingGET","parameters":[{"name":"returnShipmentId","in":"path","description":"Internal return shipment identifier assigned by OTTO Market.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnShipment__ReturnShipments-V1"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized__ReturnShipments-V1"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenGetReturnShipmentByReturnShipmentId__ReturnShipments-V1"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundGetReturnShipmentByReturnShipmentId__ReturnShipments-V1"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorGetReturnShipmentByReturnShipmentId__ReturnShipments-V1"}}}}},"deprecated":false,"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v1/return-shipments/%7BreturnShipmentId%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v1/return-shipments/%7BreturnShipmentId%7D \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v1/shipments":{"post":{"security":[{"bearerAuth":["tat.shi.w"]}],"tags":["Shipments-V1"],"summary":"Create a shipment and mark the position items as sent.","description":"This endpoint should be used to create a shipment with a list of position items. It confirms that the position items in the list have been handed over to the carrier for final delivery to the customer. At this point, the position items are marked with the state ''SENT'' in OTTO Market. This is the trigger for the generation of a purchase receipt.","operationId":"Shipments-V1__createdAndSentShipmentUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateShipmentRequest__Shipments-V1"},"examples":{"parcel delivery request":{"$ref":"#/components/examples/ShipmentCreateRequestParcelDelivery__Shipments-V1"},"forwarder delivery request":{"$ref":"#/components/examples/ShipmentCreateRequestForwarderDelivery__Shipments-V1"},"forwarder delivery request (no trackingNumber available)":{"$ref":"#/components/examples/ShipmentCreateRequestForwarderDeliveryWithoutTrackingNo__Shipments-V1"}}}},"description":"request","required":true},"responses":{"201":{"description":"Resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateShipmentResponse__Shipments-V1"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest__Shipments-V1"},"examples":{"insufficent permissions":{"$ref":"#/components/examples/ShipmentCreateInsufficientPermissionsResponse__Shipments-V1"},"tracking key mandatory":{"$ref":"#/components/examples/ShipmentCreateTrackingKeyMandatoryResponse__Shipments-V1"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized__Shipments-V1"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conflict__Shipments-V1"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError__Shipments-V1"}}}}},"deprecated":false,"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.otto.market/v1/shipments \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"trackingKey\":{\"carrier\":\"HERMES\",\"trackingNumber\":\"H1234567890123456789\"},\"shipDate\":\"2019-10-11T07:49:12.642Z\",\"shipFromAddress\":{\"city\":\"Dresden\",\"countryCode\":\"DEU\",\"zipCode\":\"01067\"},\"positionItems\":[{\"positionItemId\":\"b01b8ad2-a49c-47fc-8ade-8629ec000020\",\"salesOrderId\":\"bf43d748-f13d-49ca-b2e2-1824e9000021\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}},{\"positionItemId\":\"b01b8ad2-a49c-47fc-8ade-8629ec000022\",\"salesOrderId\":\"bf43d748-f13d-49ca-b2e2-1824e9000021\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}}]}'"},{"lang":"Shell + Httpie","source":"echo '{\"trackingKey\":{\"carrier\":\"HERMES\",\"trackingNumber\":\"H1234567890123456789\"},\"shipDate\":\"2019-10-11T07:49:12.642Z\",\"shipFromAddress\":{\"city\":\"Dresden\",\"countryCode\":\"DEU\",\"zipCode\":\"01067\"},\"positionItems\":[{\"positionItemId\":\"b01b8ad2-a49c-47fc-8ade-8629ec000020\",\"salesOrderId\":\"bf43d748-f13d-49ca-b2e2-1824e9000021\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}},{\"positionItemId\":\"b01b8ad2-a49c-47fc-8ade-8629ec000022\",\"salesOrderId\":\"bf43d748-f13d-49ca-b2e2-1824e9000021\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}}]}' | \\\n http POST https://api.otto.market/v1/shipments \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN' \\\n content-type:application/json"}]},"get":{"tags":["Shipments-V1"],"summary":"Retrieve shipments.","description":"This endpoint can be used to retrieve the shipments for a given authorized partner.","operationId":"Shipments-V1__listShipmentsUsingGET","parameters":[{"name":"datefrom","description":"Shipments created from this date onwards for the given authorized partner will be returned. The date is considered as UTC.","in":"query","required":true,"allowEmptyValue":false,"schema":{"type":"string","format":"YYYY-MM-DD"}},{"name":"limit","in":"query","description":"The maximum number of shipments to be returned in each response.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":25}},{"name":"next","in":"query","description":"The cursor which points to the next shipment that should be queried. It is used to paginate the results.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentList__Shipments-V1"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized__Shipments-V1"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorGetShipmentList__Shipments-V1"}}}}},"deprecated":false,"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.otto.market/v1/shipments?datefrom=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&next=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET 'https://api.otto.market/v1/shipments?datefrom=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&next=SOME_STRING_VALUE' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v1/shipments/carriers/{carrier}/trackingnumbers/{trackingNumber}":{"get":{"tags":["Shipments-V1"],"summary":"Retrieve shipment by carrier and tracking number.","description":"This endpoint can be used to retrieve a shipment by carrier and tracking number.","operationId":"Shipments-V1__shipmentByCarrierAndTrackingNumberUsingGET","parameters":[{"name":"carrier","in":"path","description":"The carrier of the shipment.","required":true,"schema":{"type":"string","enum":["DHL","DHL_FREIGHT","DHL_HOME_DELIVERY","GLS","HERMES","DPD","UPS","HES","HELLMANN","DB_SCHENKER","IDS","EMONS","DACHSER","LOGWIN","KUEHNE_NAGEL","SCHOCKEMOEHLE","KOCH","REITHMEIER","CARGOLINE","BURSPED","GEL","DHL_EXPRESS","MEYER_JUMBO","BTW","RHENUS","OTHER_FORWARDER"]}},{"name":"trackingNumber","in":"path","description":"The tracking number of the shipment assigned by the carrier.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment__Shipments-V1"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized__Shipments-V1"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenGetShipmentByTrackingNumber__Shipments-V1"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundGetShipmentByTrackingNumber__Shipments-V1"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorGetShipmentByTrackingNumber__Shipments-V1"}}}}},"deprecated":false,"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v1/shipments/carriers/%7Bcarrier%7D/trackingnumbers/%7BtrackingNumber%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v1/shipments/carriers/%7Bcarrier%7D/trackingnumbers/%7BtrackingNumber%7D \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v1/shipments/{shipmentId}":{"get":{"tags":["Shipments-V1"],"summary":"Retrieve shipment by shipment ID.","description":"This endpoint can be used to retrieve a shipment by OTTO internal shipment ID.","operationId":"Shipments-V1__shipmentUsingGET","parameters":[{"name":"shipmentId","in":"path","description":"Internal shipment identifier assigned by OTTO Market.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment__Shipments-V1"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized__Shipments-V1"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenGetShipmentByShipmentId__Shipments-V1"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundGetShipmentByShipmentId__Shipments-V1"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorGetShipmentByShipmentId__Shipments-V1"}}}}},"deprecated":false,"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v1/shipments/%7BshipmentId%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v1/shipments/%7BshipmentId%7D \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v1/shipments/carriers/{carrier}/trackingnumbers/{trackingNumber}/positionitems":{"post":{"security":[{"bearerAuth":["tat.shi.w"]}],"tags":["Shipments-V1"],"summary":"Correct an existing shipment (add sent items) by carrier and tracking number.","description":"This endpoint allows to update an existing shipment with new position items. Note that this is just a correction process for shipments where position items are missing. A separate purchase receipt will be generated for the newly added position items.","operationId":"Shipments-V1__appendPositionItemsByCarrierAndTrackingNumberUsingPOST","parameters":[{"name":"carrier","in":"path","description":"The carrier of the shipment.","required":true,"schema":{"type":"string","enum":["DHL","DHL_FREIGHT","DHL_HOME_DELIVERY","GLS","HERMES","DPD","UPS","HES","HELLMANN","DB_SCHENKER","IDS","EMONS","DACHSER","LOGWIN","KUEHNE_NAGEL","SCHOCKEMOEHLE","KOCH","REITHMEIER","CARGOLINE","BURSPED","GEL","DHL_EXPRESS","MEYER_JUMBO","BTW","RHENUS","OTHER_FORWARDER"]}},{"name":"trackingNumber","in":"path","description":"The tracking number of the shipment assigned by the carrier.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PositionItem__Shipments-V1"}}}},"description":"The position items included in shipment.","required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestAddPositionItemByTrackingNumber__Shipments-V1"},"examples":{"insufficent permissions":{"$ref":"#/components/examples/ShipmentAddPositionItemsInsufficientPermissionsResponse__Shipments-V1"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized__Shipments-V1"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundAddPositionItemByTrackingNumber__Shipments-V1"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictAddPositionItemByTrackingNumber__Shipments-V1"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorAddPositionItemByTrackingNumber__Shipments-V1"}}}}},"deprecated":false,"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.otto.market/v1/shipments/carriers/%7Bcarrier%7D/trackingnumbers/%7BtrackingNumber%7D/positionitems \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '[{\"positionItemId\":\"e454dff5-a96f-4e96-9399-710cf59645c2\",\"salesOrderId\":\"a46fb35b-9c77-41c9-af10-2676b756a9af\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}}]'"},{"lang":"Shell + Httpie","source":"echo '[{\"positionItemId\":\"e454dff5-a96f-4e96-9399-710cf59645c2\",\"salesOrderId\":\"a46fb35b-9c77-41c9-af10-2676b756a9af\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}}]' | \\\n http POST https://api.otto.market/v1/shipments/carriers/%7Bcarrier%7D/trackingnumbers/%7BtrackingNumber%7D/positionitems \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN' \\\n content-type:application/json"}]}},"/v1/shipments/{shipmentId}/positionitems":{"post":{"security":[{"bearerAuth":["tat.shi.w"]}],"tags":["Shipments-V1"],"summary":"Correct an existing shipment (add sent items) by shipment ID.","description":"This endpoint allows to update an existing shipment with new position items. Note that this is just a correction process for shipments where position items are missing. A separate purchase receipt will be generated for the newly added position items.","operationId":"Shipments-V1__appendPositionItemsUsingPOST","parameters":[{"name":"shipmentId","in":"path","description":"Internal shipment identifier assigned by OTTO Market.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PositionItem__Shipments-V1"}}}},"description":"positionItems","required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestAddPositionItemByShipmentId__Shipments-V1"},"examples":{"insufficent permissions":{"$ref":"#/components/examples/ShipmentAddPositionItemsInsufficientPermissionsResponse__Shipments-V1"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized__Shipments-V1"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundAddPositionItemByShipmentId__Shipments-V1"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictAddPositionItemByShipmentId__Shipments-V1"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorAddPositionItemByShipmentId__Shipments-V1"}}}}},"deprecated":false,"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.otto.market/v1/shipments/%7BshipmentId%7D/positionitems \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '[{\"positionItemId\":\"e454dff5-a96f-4e96-9399-710cf59645c2\",\"salesOrderId\":\"a46fb35b-9c77-41c9-af10-2676b756a9af\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}}]'"},{"lang":"Shell + Httpie","source":"echo '[{\"positionItemId\":\"e454dff5-a96f-4e96-9399-710cf59645c2\",\"salesOrderId\":\"a46fb35b-9c77-41c9-af10-2676b756a9af\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}}]' | \\\n http POST https://api.otto.market/v1/shipments/%7BshipmentId%7D/positionitems \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN' \\\n content-type:application/json"}]}},"/v1/multiparcel-shipments":{"post":{"security":[{"bearerAuth":["tat.shi.w"]}],"tags":["Shipments-V1"],"summary":"Create a multiparcel shipment and mark the position items as sent.","description":"This endpoint should be used to create a multiparcel shipment with a list of parcels for one position item. A shipment is a \"multiparcel shipment\" if one article (position item) is sent in several different shipments. Each shipment has its own tracking key. It confirms that the position item in the list has been handed over to the carrier for final delivery to the customer. At this point, the position item is marked with the state ''SENT'' in OTTO Market. This is the trigger for the generation of a purchase receipt.","operationId":"Shipments-V1__createdAndSentMultiparcelShipmentUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMultiparcelShipmentRequest__Shipments-V1"},"examples":{"multiparcel delivery request":{"$ref":"#/components/examples/MultiparcelShipmentCreateRequestParcelDelivery__Shipments-V1"}}}},"description":"request","required":true},"responses":{"201":{"description":"Resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMultiparcelShipmentResponse__Shipments-V1"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest__Shipments-V1"},"examples":{"insufficent permissions":{"$ref":"#/components/examples/MultiparcelShipmentCreateInsufficientPermissionsResponse__Shipments-V1"},"tracking key mandatory":{"$ref":"#/components/examples/MultiparcelShipmentCreateTrackingKeyMandatoryResponse__Shipments-V1"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized__Shipments-V1"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictMultiparcel__Shipments-V1"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorMultiparcel__Shipments-V1"}}}}},"deprecated":false,"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.otto.market/v1/multiparcel-shipments \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '[{\"trackingKey\":{\"carrier\":\"HERMES\",\"trackingNumber\":\"H1234567890123456789\"},\"shipDate\":\"2019-10-11T07:49:12.642Z\",\"shipFromAddress\":{\"city\":\"Dresden\",\"countryCode\":\"DEU\",\"zipCode\":\"01067\"},\"positionItems\":[{\"positionItemId\":\"b01b8ad2-a49c-47fc-8ade-8629ec000020\",\"salesOrderId\":\"bf43d748-f13d-49ca-b2e2-1824e9000021\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}},{\"positionItemId\":\"b01b8ad2-a49c-47fc-8ade-8629ec000022\",\"salesOrderId\":\"bf43d748-f13d-49ca-b2e2-1824e9000021\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}}]},{\"trackingKey\":{\"carrier\":\"HERMES\",\"trackingNumber\":\"H1234567890123456789\"},\"shipDate\":\"2019-10-11T07:49:12.642Z\",\"shipFromAddress\":{\"city\":\"Dresden\",\"countryCode\":\"DEU\",\"zipCode\":\"01067\"},\"positionItems\":[{\"positionItemId\":\"b01b8ad2-a49c-47fc-8ade-8629ec000020\",\"salesOrderId\":\"bf43d748-f13d-49ca-b2e2-1824e9000021\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}},{\"positionItemId\":\"b01b8ad2-a49c-47fc-8ade-8629ec000022\",\"salesOrderId\":\"bf43d748-f13d-49ca-b2e2-1824e9000021\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}}]}]'"},{"lang":"Shell + Httpie","source":"echo '[{\"trackingKey\":{\"carrier\":\"HERMES\",\"trackingNumber\":\"H1234567890123456789\"},\"shipDate\":\"2019-10-11T07:49:12.642Z\",\"shipFromAddress\":{\"city\":\"Dresden\",\"countryCode\":\"DEU\",\"zipCode\":\"01067\"},\"positionItems\":[{\"positionItemId\":\"b01b8ad2-a49c-47fc-8ade-8629ec000020\",\"salesOrderId\":\"bf43d748-f13d-49ca-b2e2-1824e9000021\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}},{\"positionItemId\":\"b01b8ad2-a49c-47fc-8ade-8629ec000022\",\"salesOrderId\":\"bf43d748-f13d-49ca-b2e2-1824e9000021\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}}]},{\"trackingKey\":{\"carrier\":\"HERMES\",\"trackingNumber\":\"H1234567890123456789\"},\"shipDate\":\"2019-10-11T07:49:12.642Z\",\"shipFromAddress\":{\"city\":\"Dresden\",\"countryCode\":\"DEU\",\"zipCode\":\"01067\"},\"positionItems\":[{\"positionItemId\":\"b01b8ad2-a49c-47fc-8ade-8629ec000020\",\"salesOrderId\":\"bf43d748-f13d-49ca-b2e2-1824e9000021\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}},{\"positionItemId\":\"b01b8ad2-a49c-47fc-8ade-8629ec000022\",\"salesOrderId\":\"bf43d748-f13d-49ca-b2e2-1824e9000021\",\"returnTrackingKey\":{\"carrier\":\"DHL\",\"trackingNumber\":\"577546565072\"}}]}]' | \\\n http POST https://api.otto.market/v1/multiparcel-shipments \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN' \\\n content-type:application/json"}]}},"/v2/returns":{"get":{"tags":["Returns-V2"],"summary":"Get all the items filtered on return status","description":"The items will be sorted on status modified time in reverse chronological order. Additionally we provide cursor based pagination via next link. This endpoint is limited to at max 50 results per page","operationId":"Returns-V2__getPositionItemsForUsingGETV2","parameters":[{"name":"limit","in":"query","description":"Page size to limit the number of items returned in the response. Maximum value for limit can 50","required":false,"allowEmptyValue":false,"example":10,"schema":{"type":"integer","format":"int32","default":10}},{"name":"page","in":"query","description":"Page number to fetch. This parameter is required to fetch data for specific page number","required":false,"allowEmptyValue":false,"example":1,"schema":{"type":"integer","format":"int32","default":1}},{"name":"status","in":"query","description":"Return status for which items are being queried for (case-insensitive)","example":"MISDIRECTED","schema":{"type":"string","enum":["MISDIRECTED","ANNOUNCED","ACCEPTED","REJECTED"]}}],"responses":{"200":{"description":"Ok","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/PositionItemList__Returns-V2"}}}},"400":{"description":"Bad Request","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse__Returns-V2"}}}},"401":{"description":"Unauthorized to access","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse__Returns-V2"}}}},"404":{"description":"Item not found","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse__Returns-V2"}}}},"500":{"description":"Internal server error","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse__Returns-V2"}}}}},"deprecated":false,"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.otto.market/v2/returns?limit=10&page=1&status=MISDIRECTED' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET 'https://api.otto.market/v2/returns?limit=10&page=1&status=MISDIRECTED' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v2/returns/acceptance":{"post":{"tags":["Returns-V2"],"summary":"Accept the return for a sent position item (up to 200 items per request)","operationId":"Returns-V2__receiveAcceptedReturnsV2UsingPOSTV2","requestBody":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/AcceptedPartnerReturnV2__Returns-V2"}}},"description":"acceptedPartnerReturn","required":true},"responses":{"200":{"description":"Ok","content":{"application/json;charset=UTF-8":{"schema":{"type":"object"}}}},"207":{"description":"Multi status","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/AcceptedReturnMultiStatusResponse__Returns-V2"}}}},"401":{"description":"Invalid token","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse__Returns-V2"}}}},"413":{"description":"Payload too large","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse__Returns-V2"}}}},"422":{"description":"Non-processable","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse__Returns-V2"}}}},"500":{"description":"Internal server error","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse__Returns-V2"}}}}},"deprecated":false,"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.otto.market/v2/returns/acceptance \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http POST https://api.otto.market/v2/returns/acceptance \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v2/returns/rejection":{"post":{"tags":["Returns-V2"],"summary":"Reject the return for a sent position item (up to 200 items per request)","operationId":"Returns-V2__receiveRejectedReturnsV2UsingPOSTV2","requestBody":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/RejectedPartnerReturnV2__Returns-V2"}}},"description":"rejectedPartnerReturn","required":true},"responses":{"200":{"description":"Ok","content":{"application/json;charset=UTF-8":{"schema":{"type":"object"}}}},"207":{"description":"Multi status","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/RejectedReturnMultiStatusResponse__Returns-V2"}}}},"401":{"description":"Invalid token","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse__Returns-V2"}}}},"413":{"description":"Payload too large","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse__Returns-V2"}}}},"422":{"description":"Non-processable","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse__Returns-V2"}}}},"500":{"description":"Internal server error","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse__Returns-V2"}}}}},"deprecated":false,"security":[{"bearerAuth":[]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.otto.market/v2/returns/rejection \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http POST https://api.otto.market/v2/returns/rejection \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v3/receipts/{receiptNumber}.pdf":{"get":{"tags":["Receipts-V3"],"summary":"Get the PDF document of a specific receipt by receipt number.","operationId":"Receipts-V3__getReceiptPdfUsingGET_3","parameters":[{"name":"receiptNumber","in":"path","description":"ReceiptNumber","required":true,"schema":{"type":"string"},"example":"R-DE-123456789-2020-1507"}],"responses":{"200":{"description":"Successfully retrieved the receipt PDF","content":{"application/pdf":{}}},"401":{"description":"Unauthorized Access"},"403":{"description":"Forbidden Access"},"404":{"description":"Receipt PDF Not Found"}},"security":[{"bearerAuth":["Receipts_Navigation_Read"]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v3/receipts/R-DE-123456789-2020-1507.pdf \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v3/receipts/R-DE-123456789-2020-1507.pdf \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v3/receipts/{receiptNumber}":{"get":{"tags":["Receipts-V3"],"summary":"Get a specific receipt for the given receipt number as JSON object","operationId":"Receipts-V3__getReceiptUsingGET_5","parameters":[{"name":"receiptNumber","in":"path","description":"ReceiptNumber","required":true,"schema":{"type":"string"},"example":"R-DE-123456789-2020-1507"}],"responses":{"200":{"description":"Successfully retrieved the receipt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt__Receipts-V3"}}}},"401":{"description":"Unauthorized Access"},"403":{"description":"Forbidden"},"404":{"description":"Receipt Not Found"}},"security":[{"bearerAuth":["Receipts_Navigation_Read"]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url https://api.otto.market/v3/receipts/R-DE-123456789-2020-1507 \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET https://api.otto.market/v3/receipts/R-DE-123456789-2020-1507 \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v3/receipts":{"get":{"tags":["Receipts-V3"],"summary":"Get all receipts as list of JSON objects","description":"The receipts will be sorted based on creationDate, latest one comes first. This endpoint is limited to at max 128 results per page","operationId":"Receipts-V3__getReceiptsUsingGET_5","parameters":[{"name":"limit","in":"query","description":"Page size to limit the number of receipts returned in the response","required":false,"schema":{"minimum":1,"type":"integer","format":"int32","default":128},"example":128},{"name":"page","in":"query","description":"Page number to fetch. This parameter is required to fetch data for specific page number.\n
This field is deprecated, please use `next` parameter","required":false,"deprecated":true,"schema":{"type":"integer","format":"int32","default":1},"example":1},{"name":"receiptTypes","in":"query","description":"Search for receipts filtered by multiple receipt types","required":false,"schema":{"type":"array","items":{"type":"string","enum":["PURCHASE","REFUND","PARTIAL_REFUND"]}}},{"name":"from","in":"query","description":"Search for receipts to filter starting from (yyyy-mm-dd)","required":false,"schema":{"type":"string","format":"date"},"example":"2022-08-01"},{"name":"to","in":"query","description":"Search for receipts to filter until (yyyy-mm-dd)","required":false,"schema":{"type":"string","format":"date"},"example":"2022-08-31"},{"name":"salesOrderId","in":"query","description":"Search for receipts filtered by sales order Id","required":false,"schema":{"type":"string"},"example":"f23eb274-a8a2-4721-a7bc-0d9aa1b11940"},{"name":"next","in":"query","description":"Cursor to fetch next receipts","required":false,"schema":{"type":"string"},"example":"eyJjcmVhdGlvbkRhdGUiOjE2ODU2OTE1NjUuMTk4MDAwMDAwLCJyZWNlaXB0TnVtYmVyIjoiRS1ERS0xMTg0NzU2OTAtMjAyMy0zNTgxMyJ9"}],"responses":{"200":{"description":"Successfully retrieved list of receipts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptsList__Receipts-V3"}}}},"401":{"description":"Unauthorized Access"},"403":{"description":"Forbidden Access"},"404":{"description":"Receipts Not Found"}},"security":[{"bearerAuth":["Receipts_Navigation_Read"]}],"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.otto.market/v3/receipts?limit=128&page=1&receiptTypes=SOME_ARRAY_VALUE&from=2022-08-01&to=2022-08-31&salesOrderId=f23eb274-a8a2-4721-a7bc-0d9aa1b11940&next=eyJjcmVhdGlvbkRhdGUiOjE2ODU2OTE1NjUuMTk4MDAwMDAwLCJyZWNlaXB0TnVtYmVyIjoiRS1ERS0xMTg0NzU2OTAtMjAyMy0zNTgxMyJ9' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET 'https://api.otto.market/v3/receipts?limit=128&page=1&receiptTypes=SOME_ARRAY_VALUE&from=2022-08-01&to=2022-08-31&salesOrderId=f23eb274-a8a2-4721-a7bc-0d9aa1b11940&next=eyJjcmVhdGlvbkRhdGUiOjE2ODU2OTE1NjUuMTk4MDAwMDAwLCJyZWNlaXB0TnVtYmVyIjoiRS1ERS0xMTg0NzU2OTAtMjAyMy0zNTgxMyJ9' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]}},"/v1/price-reductions":{"get":{"security":[{"bearerAuth":["PartialRefund_Read"]}],"tags":["Price-Reductions-V1"],"summary":"Get all priceReductions","description":"This API can be used to fetch the price reduction for a single positionItemId by providing positionId as a query parameter in the request. If the positionItemId is not specified, then this api would list the price reductions for all your products.","operationId":"Price-Reductions-V1__getAllReductionsForPartner","parameters":[{"name":"positionItemId","in":"query","description":"positionItemId for which price reductions are to be fetched","required":false,"schema":{"type":"string","format":"uuid"},"example":"72d5b4ce-83c0-43aa-9645-0913456648a8"},{"name":"page","in":"query","description":"Page number to be fetched. Page number should not be less than 1","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"Number of positionItemIds to be fetched per page. Limit should not exceed 128","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"Successfully retrieved price reductions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceReductionsResponse__Price-Reductions-V1"}}}},"401":{"description":"Unauthorized Access"},"403":{"description":"Forbidden Access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenApplyPriceReduction__Price-Reductions-V1"}}}},"404":{"description":"Price reductions Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundPriceReductionForPositionItemId__Price-Reductions-V1"}}}},"424":{"description":"Price reduction cannot be applied due to internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependency__Price-Reductions-V1"}}}}},"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request GET \\\n --url 'https://api.otto.market/v1/price-reductions?positionItemId=72d5b4ce-83c0-43aa-9645-0913456648a8&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Shell + Httpie","source":"http GET 'https://api.otto.market/v1/price-reductions?positionItemId=72d5b4ce-83c0-43aa-9645-0913456648a8&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'"}]},"post":{"security":[{"bearerAuth":["PartialRefund_Write"]}],"tags":["Price-Reductions-V1"],"summary":"Apply price reduction for a positionItemId","description":"Apply price reduction on a positionItemId.\n**Warning**: Please note that if you receive a refund of the entire product price, the shipping/forwarding costs will also be refunded. If you do not want this, we recommend that you book a price reduction minus 1 cent instead of the full amount.\n","operationId":"Price-Reductions-V1__applyPriceReduction","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPriceReductionRequest__Price-Reductions-V1"}}},"required":true},"responses":{"202":{"description":"Successfully applied price reduction for a positionItemId","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptedPriceReductionResponse__Price-Reductions-V1"}}}},"401":{"description":"Unauthorized Access"},"403":{"description":"Forbidden Access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenApplyPriceReduction__Price-Reductions-V1"}}}},"404":{"description":"PositionItemId not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundPositionItemId__Price-Reductions-V1"}}}},"409":{"description":"PositionItemId is not shipped or returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictPositionItemId__Price-Reductions-V1"}}}},"424":{"description":"Price reduction cannot be applied due to internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedDependency__Price-Reductions-V1"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorApplyPriceReduction__Price-Reductions-V1"}}}}},"x-codeSamples":[{"lang":"Shell + Curl","source":"curl --request POST \\\n --url https://api.otto.market/v1/price-reductions \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"positionItemId\":\"ef0decec-e5b7-40d8-bd91-9dafec8041a2\",\"salesOrderId\":\"9bd8f312-a044-4003-9f73-706a82f71a8f\",\"priceReduction\":{\"amount\":121.01,\"currency\":\"EUR\"}}'"},{"lang":"Shell + Httpie","source":"echo '{\"positionItemId\":\"ef0decec-e5b7-40d8-bd91-9dafec8041a2\",\"salesOrderId\":\"9bd8f312-a044-4003-9f73-706a82f71a8f\",\"priceReduction\":{\"amount\":121.01,\"currency\":\"EUR\"}}' | \\\n http POST https://api.otto.market/v1/price-reductions \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN' \\\n content-type:application/json"}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"},"onBehalfOfPartner":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://portal.otto.market/oauth2/auth","tokenUrl":"https://portal.otto.market/oauth2/token","scopes":{"installation":"read installation details of a partner","partnerId":"read Otto partner id"}}}}},"schemas":{"ActiveStatus__Products-V3":{"example":{"active":true,"lastModified":"2019-06-18T06:12:36Z","sku":"82388894-5883-488"},"properties":{"sku":{"description":"Partner-unique identifier for a product variation provided by the partner","example":"82388894-5883-488","type":"string"},"active":{"description":"The product variation is supposed to be active or not","example":true,"type":"boolean"},"lastModified":{"description":"the timestamp (GMT date and time) of the last modification of the active status","example":"2019-06-18T06:12:36Z","format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"ActiveStatusListRequest__Products-V3":{"example":{"status":[{"active":true,"lastModified":"2019-06-18T06:12:36Z","sku":"82388894-5883-488"},{"active":true,"lastModified":"2019-06-18T06:12:36Z","sku":"82388894-5883-488"}]},"properties":{"status":{"items":{"$ref":"#/components/schemas/ActiveStatus__Products-V3"},"type":"array"}},"type":"object"},"ActiveStatusListResponse__Products-V3":{"example":{"links":[{"rel":"self","href":".../products?page=0&limit=100"},{"rel":"self","href":".../products?page=0&limit=100"}],"status":[{"active":true,"lastModified":"2019-06-18T06:12:36Z","sku":"82388894-5883-488"},{"active":true,"lastModified":"2019-06-18T06:12:36Z","sku":"82388894-5883-488"}]},"properties":{"status":{"items":{"$ref":"#/components/schemas/ActiveStatus__Products-V3"},"type":"array"},"links":{"description":"a list of links that can be used for pagination (among others).","items":{"$ref":"#/components/schemas/Link__Products-V3"},"type":"array"}},"type":"object"},"AdditionalRequirement__Products-V3":{"example":{"reference":"https://api.otto.market/docs/03_Products/v3/products-interface.html","featureRelevance":["LEGAL"],"condition":{"name":"name","jsonPath":"jsonPath","value":"value"},"name":"normPriceInfo","description":"Die Produktkategorie fällt unter die Preisangabenverordnung, weshalb ein Grundpreis angegeben werden muss.","jsonPath":"$.productVariations[*].pricing.normPriceInfo"},"properties":{"name":{"description":"the name of the product attribute.","example":"normPriceInfo","type":"string"},"jsonPath":{"description":"the JSON path leading to the specific product attribute.","example":"$.productVariations[*].pricing.normPriceInfo","type":"string"},"description":{"description":"a brief human readable description of the requirement","example":"Die Produktkategorie fällt unter die Preisangabenverordnung, weshalb ein Grundpreis angegeben werden muss.","type":"string"},"reference":{"description":"a link to the official documentation that describes the requirement","example":"https://api.otto.market/docs/03_Products/v3/products-interface.html","type":"string"},"condition":{"$ref":"#/components/schemas/Condition__Products-V3"},"featureRelevance":{"description":"a list of feature relevances that can describe the reason for the requirement.","example":["LEGAL"],"items":{"type":"string"},"type":"array"}},"type":"object"},"Attribute__Products-V3":{"example":{"values":["34"],"additional":true,"name":"Bundweite"},"properties":{"name":{"description":"The name of the describing attribute, like 'color' or 'size'.","example":"Bundweite","type":"string"},"values":{"description":"The value for the given name, like 'blue' or 'S', as a JSON array","example":["34"],"items":{"type":"string"},"type":"array"},"additional":{"description":"true, if the attribute is not defined by the marketplace.","example":true,"type":"boolean"}},"type":"object"},"AttributeDefinition__Products-V3":{"example":{"allowedValues":"natur bunt grau ...","featureRelevance":"FILTER","attributeGroup":"Maße & Gewicht","description":"some textual description","recommendedValues":"modern klassisch Landhaus Vintage","type":"FLOAT","multiValue":true,"relevance":"HIGH","unitDisplayName":"Zentimeter","reference":"http://wikipedia.de/something","unit":"cm","relatedMediaAssets":["relatedMediaAssets","relatedMediaAssets"],"name":"Durchmesser","exampleValues":"Edelstahl Aluminium Stahl"},"properties":{"name":{"description":"the name of the attribute. This attribute name has to be used within the product description.","example":"Durchmesser","type":"string"},"attributeGroup":{"description":"title of the attributes displayed in the product details in the shop.","example":"Maße & Gewicht","type":"string"},"type":{"description":"defines the format of the attribute value, such as string, integer, etc.","example":"FLOAT","type":"string"},"multiValue":{"description":"if the value is true, several values can be transferred to this attribute (polyvalence attribute); otherwise, only a single value may be transferred to this attribute.","example":true,"type":"boolean"},"unit":{"description":"the values must be transferred in the specified unit.","example":"cm","type":"string"},"unitDisplayName":{"description":"the value gets displayed with this unit in the shop.","example":"Zentimeter","type":"string"},"allowedValues":{"description":"only the listed values are permitted for the attribute.","example":"natur bunt grau ...","items":{"type":"string"},"type":"array"},"featureRelevance":{"description":"describes what the attribute can be used for and where it gets displayed in the shop.","example":"FILTER","items":{"type":"string"},"type":"array"},"relatedMediaAssets":{"description":"mandatory media assets for the category","items":{"type":"string"},"type":"array"},"relevance":{"description":"the relevance of the attribute.","example":"HIGH","type":"string"},"description":{"description":"additional information for the attribute.","example":"some textual description","type":"string"},"exampleValues":{"description":"example values for the attribute.","example":"Edelstahl Aluminium Stahl","items":{"type":"string"},"type":"array"},"recommendedValues":{"description":"use the listed values to get full navigation and filter features on otto.de. If no suitable value exists, then enter your own value.","example":"modern klassisch Landhaus Vintage","items":{"type":"string"},"type":"array"},"reference":{"description":"reference to further documentation.","example":"http://wikipedia.de/something","type":"string"}},"type":"object"},"Brand__Products-V3":{"example":{"usable":true,"name":"adidas","logo":"https://brandlogos.foo.org/logo-xyz.jpg","id":"K5J8PJFR"},"properties":{"id":{"description":"the id value of the brand which you have to use with your product data uploads!","example":"K5J8PJFR","type":"string"},"name":{"description":"the name of the brand as it is known on the OTTO marketplace. Use this name to find the brand of your products in the list of available brands, but don't use it in your product data - use only the id value of the brand!","example":"adidas","type":"string"},"logo":{"description":"If a brand logo image is existing, you can find the URL of it here.","example":"https://brandlogos.foo.org/logo-xyz.jpg","type":"string"},"usable":{"description":"If this value if ``false`` you are not allowed to use this brand for products you like to sell on the OTTO marketplace. If the value is ``true`` you might use this brand.","example":true,"type":"boolean"}},"type":"object"},"BrandListResponse__Products-V3":{"example":{"brands":[{"usable":true,"name":"adidas","logo":"https://brandlogos.foo.org/logo-xyz.jpg","id":"K5J8PJFR"},{"usable":true,"name":"adidas","logo":"https://brandlogos.foo.org/logo-xyz.jpg","id":"K5J8PJFR"}],"links":[{"rel":"self","href":".../products?page=0&limit=100"},{"rel":"self","href":".../products?page=0&limit=100"}]},"properties":{"brands":{"items":{"$ref":"#/components/schemas/Brand__Products-V3"},"type":"array"},"links":{"description":"a list of links that can be used for pagination (among others).","items":{"$ref":"#/components/schemas/Link__Products-V3"},"type":"array"}},"type":"object"},"CategoryGroup__Products-V3":{"example":{"createdAt":"2021-07-02T01:35:57.181Z","additionalRequirements":[{"reference":"https://api.otto.market/docs/03_Products/v3/products-interface.html","featureRelevance":["LEGAL"],"condition":{"name":"name","jsonPath":"jsonPath","value":"value"},"name":"normPriceInfo","description":"Die Produktkategorie fällt unter die Preisangabenverordnung, weshalb ein Grundpreis angegeben werden muss.","jsonPath":"$.productVariations[*].pricing.normPriceInfo"},{"reference":"https://api.otto.market/docs/03_Products/v3/products-interface.html","featureRelevance":["LEGAL"],"condition":{"name":"name","jsonPath":"jsonPath","value":"value"},"name":"normPriceInfo","description":"Die Produktkategorie fällt unter die Preisangabenverordnung, weshalb ein Grundpreis angegeben werden muss.","jsonPath":"$.productVariations[*].pricing.normPriceInfo"}],"attributes":[{"allowedValues":"natur bunt grau ...","featureRelevance":"FILTER","attributeGroup":"Maße & Gewicht","description":"some textual description","recommendedValues":"modern klassisch Landhaus Vintage","type":"FLOAT","multiValue":true,"relevance":"HIGH","unitDisplayName":"Zentimeter","reference":"http://wikipedia.de/something","unit":"cm","relatedMediaAssets":["relatedMediaAssets","relatedMediaAssets"],"name":"Durchmesser","exampleValues":"Edelstahl Aluminium Stahl"},{"allowedValues":"natur bunt grau ...","featureRelevance":"FILTER","attributeGroup":"Maße & Gewicht","description":"some textual description","recommendedValues":"modern klassisch Landhaus Vintage","type":"FLOAT","multiValue":true,"relevance":"HIGH","unitDisplayName":"Zentimeter","reference":"http://wikipedia.de/something","unit":"cm","relatedMediaAssets":["relatedMediaAssets","relatedMediaAssets"],"name":"Durchmesser","exampleValues":"Edelstahl Aluminium Stahl"}],"categories":"Farbe","lastModified":"2021-07-02T01:35:57.181Z","title":"title","categoryGroup":"categoryGroup","variationThemes":["variationThemes","variationThemes"]},"properties":{"categoryGroup":{"description":"a category group defines a list of categories and the market place attributes for these categories.","type":"string"},"categories":{"description":"the list of the categories for this category group.","example":"Farbe","items":{"type":"string"},"type":"array"},"variationThemes":{"description":"overview of all attributes that can be used to create variantions.","items":{"type":"string"},"type":"array"},"title":{"description":"shows how our product title is built","type":"string"},"attributes":{"description":"list of the market place attributes for the categories of this group.","items":{"$ref":"#/components/schemas/AttributeDefinition__Products-V3"},"type":"array"},"createdAt":{"description":"creation date date of the category.","example":"2021-07-02T01:35:57.181Z","format":"date-time","type":"string"},"lastModified":{"description":"last modification date of the category.","example":"2021-07-02T01:35:57.181Z","format":"date-time","type":"string"},"additionalRequirements":{"description":"a list of general requirements for certain product attributes that apply to all categories in the category group","items":{"$ref":"#/components/schemas/AdditionalRequirement__Products-V3"},"type":"array"}},"type":"object"},"CategoryGroups__Products-V3":{"example":{"categoryGroups":[{"createdAt":"2021-07-02T01:35:57.181Z","additionalRequirements":[{"reference":"https://api.otto.market/docs/03_Products/v3/products-interface.html","featureRelevance":["LEGAL"],"condition":{"name":"name","jsonPath":"jsonPath","value":"value"},"name":"normPriceInfo","description":"Die Produktkategorie fällt unter die Preisangabenverordnung, weshalb ein Grundpreis angegeben werden muss.","jsonPath":"$.productVariations[*].pricing.normPriceInfo"},{"reference":"https://api.otto.market/docs/03_Products/v3/products-interface.html","featureRelevance":["LEGAL"],"condition":{"name":"name","jsonPath":"jsonPath","value":"value"},"name":"normPriceInfo","description":"Die Produktkategorie fällt unter die Preisangabenverordnung, weshalb ein Grundpreis angegeben werden muss.","jsonPath":"$.productVariations[*].pricing.normPriceInfo"}],"attributes":[{"allowedValues":"natur bunt grau ...","featureRelevance":"FILTER","attributeGroup":"Maße & Gewicht","description":"some textual description","recommendedValues":"modern klassisch Landhaus Vintage","type":"FLOAT","multiValue":true,"relevance":"HIGH","unitDisplayName":"Zentimeter","reference":"http://wikipedia.de/something","unit":"cm","relatedMediaAssets":["relatedMediaAssets","relatedMediaAssets"],"name":"Durchmesser","exampleValues":"Edelstahl Aluminium Stahl"},{"allowedValues":"natur bunt grau ...","featureRelevance":"FILTER","attributeGroup":"Maße & Gewicht","description":"some textual description","recommendedValues":"modern klassisch Landhaus Vintage","type":"FLOAT","multiValue":true,"relevance":"HIGH","unitDisplayName":"Zentimeter","reference":"http://wikipedia.de/something","unit":"cm","relatedMediaAssets":["relatedMediaAssets","relatedMediaAssets"],"name":"Durchmesser","exampleValues":"Edelstahl Aluminium Stahl"}],"categories":"Farbe","lastModified":"2021-07-02T01:35:57.181Z","title":"title","categoryGroup":"categoryGroup","variationThemes":["variationThemes","variationThemes"]},{"createdAt":"2021-07-02T01:35:57.181Z","additionalRequirements":[{"reference":"https://api.otto.market/docs/03_Products/v3/products-interface.html","featureRelevance":["LEGAL"],"condition":{"name":"name","jsonPath":"jsonPath","value":"value"},"name":"normPriceInfo","description":"Die Produktkategorie fällt unter die Preisangabenverordnung, weshalb ein Grundpreis angegeben werden muss.","jsonPath":"$.productVariations[*].pricing.normPriceInfo"},{"reference":"https://api.otto.market/docs/03_Products/v3/products-interface.html","featureRelevance":["LEGAL"],"condition":{"name":"name","jsonPath":"jsonPath","value":"value"},"name":"normPriceInfo","description":"Die Produktkategorie fällt unter die Preisangabenverordnung, weshalb ein Grundpreis angegeben werden muss.","jsonPath":"$.productVariations[*].pricing.normPriceInfo"}],"attributes":[{"allowedValues":"natur bunt grau ...","featureRelevance":"FILTER","attributeGroup":"Maße & Gewicht","description":"some textual description","recommendedValues":"modern klassisch Landhaus Vintage","type":"FLOAT","multiValue":true,"relevance":"HIGH","unitDisplayName":"Zentimeter","reference":"http://wikipedia.de/something","unit":"cm","relatedMediaAssets":["relatedMediaAssets","relatedMediaAssets"],"name":"Durchmesser","exampleValues":"Edelstahl Aluminium Stahl"},{"allowedValues":"natur bunt grau ...","featureRelevance":"FILTER","attributeGroup":"Maße & Gewicht","description":"some textual description","recommendedValues":"modern klassisch Landhaus Vintage","type":"FLOAT","multiValue":true,"relevance":"HIGH","unitDisplayName":"Zentimeter","reference":"http://wikipedia.de/something","unit":"cm","relatedMediaAssets":["relatedMediaAssets","relatedMediaAssets"],"name":"Durchmesser","exampleValues":"Edelstahl Aluminium Stahl"}],"categories":"Farbe","lastModified":"2021-07-02T01:35:57.181Z","title":"title","categoryGroup":"categoryGroup","variationThemes":["variationThemes","variationThemes"]}],"links":[{"rel":"self","href":".../products?page=0&limit=100"},{"rel":"self","href":".../products?page=0&limit=100"}]},"properties":{"categoryGroups":{"description":"a list of the category groups defined on the OTTO market place.","items":{"$ref":"#/components/schemas/CategoryGroup__Products-V3"},"type":"array"},"links":{"description":"a list of links that can be used for pagination (among others).","items":{"$ref":"#/components/schemas/Link__Products-V3"},"type":"array"}},"type":"object"},"Condition__Products-V3":{"example":{"name":"name","jsonPath":"jsonPath","value":"value"},"properties":{"name":{"description":"the name of an attribute.","type":"string"},"jsonPath":{"description":"the JSON path that leads to the attribute value.","type":"string"},"value":{"description":"the value of the attribute to which the requirement applies.","type":"string"}},"type":"object"},"ContentChange__Products-V3":{"example":{"ean":"ean","shopLink":"shopLink","productReference":"productReference","sku":"sku","lastContentChange":"2000-01-23T04:56:07.000+00:00"},"properties":{"sku":{"type":"string"},"ean":{"type":"string"},"productReference":{"type":"string"},"shopLink":{"type":"string"},"lastContentChange":{"format":"date-time","type":"string"}},"type":"object"},"ContentChangesApiResult__Products-V3":{"example":{"contentChanges":[{"ean":"ean","shopLink":"shopLink","productReference":"productReference","sku":"sku","lastContentChange":"2000-01-23T04:56:07.000+00:00"},{"ean":"ean","shopLink":"shopLink","productReference":"productReference","sku":"sku","lastContentChange":"2000-01-23T04:56:07.000+00:00"}],"links":[{"rel":"self","href":".../products?page=0&limit=100"},{"rel":"self","href":".../products?page=0&limit=100"}]},"properties":{"contentChanges":{"items":{"$ref":"#/components/schemas/ContentChange__Products-V3"},"type":"array"},"links":{"description":"a list of links that can be used for pagination.","items":{"$ref":"#/components/schemas/ContentChangesLink__Products-V3"},"type":"array"}},"type":"object"},"Delivery__Products-V3":{"description":"A container holding attributes to describe the way you ship the orders to the customers","example":{"deliveryTime":1,"type":"PARCEL"},"properties":{"type":{"description":"The type of the delivery as described in the enumeration. Right now we only support PARCEL, FORWARDER_PREFERREDLOCATION, FORWARDER_CURBSIDE and FORWARDER_HEAVYDUTY.","enum":["PARCEL","FORWARDER_PREFERREDLOCATION","FORWARDER_CURBSIDE","FORWARDER_HEAVYDUTY"],"example":"PARCEL","type":"string"},"deliveryTime":{"description":"Mandatory. The delivery time in days, with allowed values from 1 to 999.","example":1,"format":"int32","type":"integer"}},"required":["deliveryTime","type"],"type":"object"},"Link__Products-V3":{"example":{"rel":"self","href":".../products?page=0&limit=100"},"properties":{"rel":{"description":"link relation type","enum":["self","prev","next"],"example":"self","type":"string"},"href":{"description":"the linked reference as URI","example":".../products?page=0&limit=100","type":"string"}},"type":"object"},"ContentChangesLink__Products-V3":{"example":{"rel":"self","href":".../products?page=0&limit=100"},"properties":{"rel":{"description":"link relation type","enum":["self","prev","next"],"example":"self","type":"string"},"href":{"description":"the linked reference as URI","example":".../products?page=0&limit=100","type":"string"}},"type":"object"},"LinkRelation__Products-V3":{"type":"object"},"Logistics__Products-V3":{"description":"In case of using the logistic service of our marketplace, here you may provide information about the packaging of the goods","example":{"packingUnitCount":3,"packingUnits":[{"width":600,"length":300,"weight":365,"height":200},{"width":600,"length":300,"weight":365,"height":200}]},"properties":{"packingUnitCount":{"description":"The number of packing units.","example":3,"format":"int32","type":"integer"},"packingUnits":{"description":"The measurements of the packing units in g and mm.","items":{"$ref":"#/components/schemas/PackingUnit__Products-V3"},"type":"array"}},"type":"object"},"MarketPlaceStatus__Products-V3":{"example":{"moin":"M00A1234BC","information":[{"code":"300007 - INCOMPLETE_MEDIA_ASSET_IMPORT","title":"Die Bilder werden zur Zeit verarbeitet. Wir bitten um etwas Geduld. Wenn der Status sich innerhalb der nächsten 24 Stunden nicht verändert, wenden Sie sich bitte an support@otto.market."},{"code":"300007 - INCOMPLETE_MEDIA_ASSET_IMPORT","title":"Die Bilder werden zur Zeit verarbeitet. Wir bitten um etwas Geduld. Wenn der Status sich innerhalb der nächsten 24 Stunden nicht verändert, wenden Sie sich bitte an support@otto.market."}],"links":[{"rel":"shop","href":"https://www.otto.de/p/myProduct"},{"rel":"shop","href":"https://www.otto.de/p/myProduct"}],"lastModified":"2021-07-02T09:30:52.093Z","sku":"82388894-5883-488","errors":[{"code":"800020 - PRODUCTDATASHEET_MISSING","title":"Das Produktdatenblatt fehlt."},{"code":"800020 - PRODUCTDATASHEET_MISSING","title":"Das Produktdatenblatt fehlt."}],"status":"RESTRICTED"},"properties":{"sku":{"description":"Partner-unique identifier for a product variation provided by the partner","example":"82388894-5883-488","type":"string"},"moin":{"description":"Is an identifier, generated by the OTTO marketplace, for a product variation together with the associated content. Is used in the context of \"Wettbewerb am Artikel\" to confirm the content of the existing variation and its correctness and to put the own offer live for this variation.","example":"M00A1234BC","type":"string"},"status":{"description":"the status of the variation on the OTTO market place","enum":["PENDING","ONLINE","RESTRICTED","REJECTED","INACTIVE"],"example":"RESTRICTED","type":"string"},"errors":{"description":"errors that occurred when processing the variation","items":{"$ref":"#/components/schemas/MarketPlaceStatusError__Products-V3"},"type":"array"},"information":{"description":"information for product optimization on the OTTO market place","items":{"$ref":"#/components/schemas/MarketPlaceStatusInformation__Products-V3"},"type":"array"},"links":{"description":"contains the link to the partner variation data and to the product in OTTO shop","items":{"$ref":"#/components/schemas/MarketPlaceStatusLink__Products-V3"},"type":"array"},"lastModified":{"description":"last change of the marketplace status","example":"2021-07-02T09:30:52.093Z","format":"date-time","type":"string"}},"type":"object"},"MarketPlaceStatusApiResult__Products-V3":{"example":{"marketPlaceStatus":[{"moin":"M00A1234BC","information":[{"code":"300007 - INCOMPLETE_MEDIA_ASSET_IMPORT","title":"Die Bilder werden zur Zeit verarbeitet. Wir bitten um etwas Geduld. Wenn der Status sich innerhalb der nächsten 24 Stunden nicht verändert, wenden Sie sich bitte an support@otto.market."},{"code":"300007 - INCOMPLETE_MEDIA_ASSET_IMPORT","title":"Die Bilder werden zur Zeit verarbeitet. Wir bitten um etwas Geduld. Wenn der Status sich innerhalb der nächsten 24 Stunden nicht verändert, wenden Sie sich bitte an support@otto.market."}],"links":[{"rel":"shop","href":"https://www.otto.de/p/myProduct"},{"rel":"shop","href":"https://www.otto.de/p/myProduct"}],"lastModified":"2021-07-02T09:30:52.093Z","sku":"82388894-5883-488","errors":[{"code":"800020 - PRODUCTDATASHEET_MISSING","title":"Das Produktdatenblatt fehlt."},{"code":"800020 - PRODUCTDATASHEET_MISSING","title":"Das Produktdatenblatt fehlt."}],"status":"RESTRICTED"},{"moin":"M00A1234BC","information":[{"code":"300007 - INCOMPLETE_MEDIA_ASSET_IMPORT","title":"Die Bilder werden zur Zeit verarbeitet. Wir bitten um etwas Geduld. Wenn der Status sich innerhalb der nächsten 24 Stunden nicht verändert, wenden Sie sich bitte an support@otto.market."},{"code":"300007 - INCOMPLETE_MEDIA_ASSET_IMPORT","title":"Die Bilder werden zur Zeit verarbeitet. Wir bitten um etwas Geduld. Wenn der Status sich innerhalb der nächsten 24 Stunden nicht verändert, wenden Sie sich bitte an support@otto.market."}],"links":[{"rel":"shop","href":"https://www.otto.de/p/myProduct"},{"rel":"shop","href":"https://www.otto.de/p/myProduct"}],"lastModified":"2021-07-02T09:30:52.093Z","sku":"82388894-5883-488","errors":[{"code":"800020 - PRODUCTDATASHEET_MISSING","title":"Das Produktdatenblatt fehlt."},{"code":"800020 - PRODUCTDATASHEET_MISSING","title":"Das Produktdatenblatt fehlt."}],"status":"RESTRICTED"}],"links":[{"rel":"self","href":".../products?page=0&limit=100"},{"rel":"self","href":".../products?page=0&limit=100"}]},"properties":{"marketPlaceStatus":{"items":{"$ref":"#/components/schemas/MarketPlaceStatus__Products-V3"},"type":"array"},"links":{"description":"a list of links that can be used for pagination.","items":{"$ref":"#/components/schemas/Link__Products-V3"},"type":"array"}},"type":"object"},"MarketPlaceStatusError__Products-V3":{"example":{"code":"800020 - PRODUCTDATASHEET_MISSING","title":"Das Produktdatenblatt fehlt."},"properties":{"code":{"description":"code to identify the error","example":"800020 - PRODUCTDATASHEET_MISSING","type":"string"},"title":{"description":"short description of the error","example":"Das Produktdatenblatt fehlt.","type":"string"}},"type":"object"},"MarketPlaceStatusInformation__Products-V3":{"example":{"code":"300007 - INCOMPLETE_MEDIA_ASSET_IMPORT","title":"Die Bilder werden zur Zeit verarbeitet. Wir bitten um etwas Geduld. Wenn der Status sich innerhalb der nächsten 24 Stunden nicht verändert, wenden Sie sich bitte an support@otto.market."},"properties":{"code":{"description":"code to identify the information","example":"300007 - INCOMPLETE_MEDIA_ASSET_IMPORT","type":"string"},"title":{"description":"short description of the information","example":"Die Bilder werden zur Zeit verarbeitet. Wir bitten um etwas Geduld. Wenn der Status sich innerhalb der nächsten 24 Stunden nicht verändert, wenden Sie sich bitte an support@otto.market.","type":"string"}},"type":"object"},"MarketPlaceStatusLink__Products-V3":{"example":{"rel":"shop","href":"https://www.otto.de/p/myProduct"},"properties":{"rel":{"description":"link relation type","enum":["variation","shop"],"example":"shop","type":"string"},"href":{"description":"the linked reference as URI","example":"https://www.otto.de/p/myProduct","type":"string"}},"type":"object"},"MediaAsset__Products-V3":{"example":{"location":"http://apartners.url/image-location","type":"IMAGE"},"properties":{"type":{"description":"The type of the provided media asset. At least one media asset of type 'IMAGE' must be provided. The number of media assets of type 'IMAGE' is not limited.","enum":["IMAGE","DIMENSIONAL_DRAWING","COLOR_VARIANT","ENERGY_EFFICIENCY_LABEL","MATERIAL_SAMPLE","PRODUCT_DATASHEET","USER_MANUAL","MANUFACTURER_WARRANTY","SAFETY_DATASHEET","ASSEMBLY_INSTRUCTIONS","WARNING_LABEL"],"example":"IMAGE","type":"string"},"location":{"description":"The partners location of the media asset as a valid URL (see http://www.ietf.org/rfc/rfc2396.txt and http://www.ietf.org/rfc/rfc2732.txt) with a maximum length of 2083 characters. OTTO market will use the link for downloading the media asset and providing it to otto.de. Please note that the image has to be of type JPG or PNG with a RGB color space an a minimum size of 500x1000 pixel and a maximum width of 4500 pixel.","example":"http://apartners.url/image-location","format":"uri","type":"string"}},"required":["location","type"],"type":"object"},"MonetaryAmount__Products-V3":{"example":{"amount":19.95,"currency":"EUR"},"properties":{"amount":{"description":"Holds the value of the monetary amount expressed in a currency, e.g. euros. The number format expects a decimal point, like 10.99. Numbers without a decimal point are taken as a unit of the given currency, e.g. 10 is taken as 10 euros. The value has to have no more than 2 decimal places. If you specify more decimal places, the product variation will be rejected. The same applies, if you use other characters than digits and an optional decimal point, e.g. '2E+4'","example":19.95,"type":"number"},"currency":{"description":"Holds the currency of the monetary amount expressed as a shortcut according to ISO 4217 and http://publications.europa.eu/code/de/de-5000700.htm. NOTE: Currently the only allowed currency code is \"EUR\". All other currency codes will be rejected.","example":"EUR","type":"string"}},"type":"object"},"NormPriceInfo__Products-V3":{"description":"The information about normed prices, must be provided completely, or not at all. The representation of the normprice has to contain the following values for normAmount and normUnit: 1 pcs,1 sqm,1 kg,1 l,1 m,100 ml,100 g,1 g,1000 g,1 pair,1 RM,1 dm3.","example":{"normAmount":100,"normUnit":"g","salesAmount":500,"salesUnit":"g"},"properties":{"normAmount":{"description":"The norm packaging size.","enum":[1,100,1000],"example":100,"format":"int32","type":"integer"},"normUnit":{"description":"The name of the unit the norm price is based on.","enum":["Stk","qm","kg","l","m","ml","g","Paar","RM","dm3"],"example":"g","type":"string"},"salesAmount":{"description":"The packaging size of the sales unit.","example":500,"type":"number"},"salesUnit":{"description":"The name of the unit the sales price is based on.","enum":["Stk","qm","kg","l","m","ml","g","Paar","RM","dm3"],"example":"g","type":"string"}},"type":"object"},"PackingUnit__Products-V3":{"example":{"width":600,"length":300,"weight":365,"height":200},"properties":{"weight":{"description":"The weight of a packing unit in grams.","example":365,"format":"int32","type":"integer"},"width":{"description":"The width of a packing unit in millimeters.","example":600,"format":"int32","type":"integer"},"height":{"description":"The height of a packing unit in millimeters.","example":200,"format":"int32","type":"integer"},"length":{"description":"The depth of a packing unit in millimeters.","example":300,"format":"int32","type":"integer"}},"type":"object"},"PriceApiResult__Products-V3":{"example":{"variationPrices":[{"sale":{"salePrice":{"amount":19.95,"currency":"EUR"},"endDate":"2019-10-19T09:30:00Z","startDate":"2019-10-19T09:30:00Z"},"standardPrice":{"amount":19.95,"currency":"EUR"},"sku":"sku"},{"sale":{"salePrice":{"amount":19.95,"currency":"EUR"},"endDate":"2019-10-19T09:30:00Z","startDate":"2019-10-19T09:30:00Z"},"standardPrice":{"amount":19.95,"currency":"EUR"},"sku":"sku"}],"links":[{"rel":"self","href":".../products?page=0&limit=100"},{"rel":"self","href":".../products?page=0&limit=100"}]},"properties":{"variationPrices":{"items":{"$ref":"#/components/schemas/SkuPricing__Products-V3"},"type":"array"},"links":{"description":"a list of links that can be used for pagination.","items":{"$ref":"#/components/schemas/Link__Products-V3"},"type":"array"}},"type":"object"},"Pricing__Products-V3":{"description":"this container holds attributes for the different price types, currency and tax related information","example":{"sale":{"salePrice":{"amount":19.95,"currency":"EUR"},"endDate":"2019-10-19T09:30:00Z","startDate":"2019-10-19T09:30:00Z"},"normPriceInfo":{"normAmount":100,"normUnit":"g","salesAmount":500,"salesUnit":"g"},"msrp":{"amount":19.95,"currency":"EUR"},"vat":"FULL","standardPrice":{"amount":19.95,"currency":"EUR"}},"properties":{"standardPrice":{"$ref":"#/components/schemas/MonetaryAmount__Products-V3"},"vat":{"description":"The value added tax that is included in the sales price, currently FULL or REDUCED","enum":["FULL","REDUCED","FREE"],"example":"FULL","type":"string"},"msrp":{"$ref":"#/components/schemas/MonetaryAmount__Products-V3"},"sale":{"$ref":"#/components/schemas/Sale__Products-V3"},"normPriceInfo":{"$ref":"#/components/schemas/NormPriceInfo__Products-V3"}},"required":["standardPrice","vat"],"type":"object"},"ProductDescription__Products-V3":{"description":"Extensive description of the product.","example":{"description":"

Some example words...in bold...some more

","type":"string"},"bulletPoints":{"description":"May contain a minimum of 3 and a maximum of 180 characters.","example":["My top key information..."],"items":{"type":"string"},"type":"array"},"attributes":{"description":"Lists all the descriptive information about a product variant a partner can provide. Must be provided in the form of a key values pair. Will be validated against the AttributeDefinitions from Category endpoint provided by Otto market.","items":{"$ref":"#/components/schemas/Attribute__Products-V3"},"type":"array"}},"required":["brandId","category"],"type":"object"},"ProductLink__Products-V3":{"type":"object"},"ProductProcessProgress__Products-V3":{"example":{"total":0,"unchanged":5,"progress":6,"pingAfter":"2020-05-13T10:40:01.815Z","links":[{"rel":"self","href":"\n.../products/update-tasks/11111111-0003-4444-9999-bbbbbbbbbbbbb/succeeded\n\n.../products/update-tasks/11111111-0003-4444-9999-bbbbbbbbbbbbb/failed\n\n.../products/update-tasks/11111111-0003-4444-9999-bbbbbbbbbbbbb/unchanged\n"},{"rel":"self","href":"\n.../products/update-tasks/11111111-0003-4444-9999-bbbbbbbbbbbbb/succeeded\n\n.../products/update-tasks/11111111-0003-4444-9999-bbbbbbbbbbbbb/failed\n\n.../products/update-tasks/11111111-0003-4444-9999-bbbbbbbbbbbbb/unchanged\n"}],"state":"pending","failed":5,"message":"message","succeeded":1},"properties":{"state":{"description":"the current state of the process","enum":["pending","done"],"type":"string"},"message":{"description":"a human-readable message describing the current state of the process","type":"string"},"total":{"description":"the total work to complete for this process","format":"int32","type":"integer"},"progress":{"description":"the fraction of work that is already completed, as compared to the total work","format":"int32","type":"integer"},"succeeded":{"description":"the number of successfully processed variations","format":"int32","type":"integer"},"failed":{"description":"the number of failed processed variations","format":"int32","type":"integer"},"unchanged":{"description":"the number of unchanged and not processed variations","format":"int32","type":"integer"},"pingAfter":{"description":"recommendation when to poll this resource again to receive a meaningful update","example":"2020-05-13T10:40:01.815Z","format":"date-time","type":"string"},"links":{"description":"a list of links that can be used to access detailed information about the process result","items":{"$ref":"#/components/schemas/ProductProcessResultLink__Products-V3"},"type":"array"}},"type":"object"},"ProductProcessResult__Products-V3":{"example":{"results":[{"urlToShopProduct":"{}","variation":"variation","errors":[{"path":"path","code":"code","logref":"logref","jsonPath":"jsonPath","title":"title"},{"path":"path","code":"code","logref":"logref","jsonPath":"jsonPath","title":"title"}]},{"urlToShopProduct":"{}","variation":"variation","errors":[{"path":"path","code":"code","logref":"logref","jsonPath":"jsonPath","title":"title"},{"path":"path","code":"code","logref":"logref","jsonPath":"jsonPath","title":"title"}]}]},"properties":{"results":{"items":{"$ref":"#/components/schemas/ProductProcessTaskResult__Products-V3"},"type":"array"}},"type":"object"},"ProductProcessResultLink__Products-V3":{"example":{"rel":"self","href":"\n.../products/update-tasks/11111111-0003-4444-9999-bbbbbbbbbbbbb/succeeded\n\n.../products/update-tasks/11111111-0003-4444-9999-bbbbbbbbbbbbb/failed\n\n.../products/update-tasks/11111111-0003-4444-9999-bbbbbbbbbbbbb/unchanged\n"},"properties":{"rel":{"description":"link relation type","enum":["self","failed","succeeded","unchanged"],"type":"string"},"href":{"description":"the linked reference as URI","example":"\n.../products/update-tasks/11111111-0003-4444-9999-bbbbbbbbbbbbb/succeeded\n\n.../products/update-tasks/11111111-0003-4444-9999-bbbbbbbbbbbbb/failed\n\n.../products/update-tasks/11111111-0003-4444-9999-bbbbbbbbbbbbb/unchanged\n","type":"string"}},"type":"object"},"ProductProcessTaskError__Products-V3":{"example":{"path":"path","code":"code","logref":"logref","jsonPath":"jsonPath","title":"title"},"properties":{"code":{"type":"string"},"title":{"type":"string"},"path":{"type":"string"},"jsonPath":{"type":"string"},"logref":{"type":"string"}},"type":"object"},"ProductProcessTaskResult__Products-V3":{"example":{"urlToShopProduct":"{}","variation":"variation","errors":[{"path":"path","code":"code","logref":"logref","jsonPath":"jsonPath","title":"title"},{"path":"path","code":"code","logref":"logref","jsonPath":"jsonPath","title":"title"}]},"properties":{"variation":{"type":"string"},"urlToShopProduct":{"type":"object"},"errors":{"items":{"$ref":"#/components/schemas/ProductProcessTaskError__Products-V3"},"type":"array"}},"type":"object"},"ProductVariation__Products-V3":{"example":{"delivery":{"deliveryTime":1,"type":"PARCEL"},"pzn":"PZN-4908802","releaseDate":"2019-10-19T00:00:00Z","mediaAssets":[{"location":"http://apartners.url/image-location","type":"IMAGE"},{"location":"http://apartners.url/image-location","type":"IMAGE"}],"productReference":"UBN-11779","logistics":{"packingUnitCount":3,"packingUnits":[{"width":600,"length":300,"weight":365,"height":200},{"width":600,"length":300,"weight":365,"height":200}]},"mpn":"H2G2-42","ean":"3858389911564","moin":"M00A1234BC","sku":"3858389911564","productDescription":{"description":"

Some example words...in bold...some more

","fscCertified":true,"disposal":false,"manufacturer":"3M","productLine":"501","productionDate":"2021-07-02T09:30:52.093Z","brandId":"CMWBBRW2","bulletPoints":["My top key information..."],"attributes":[{"values":["34"],"additional":true,"name":"Bundweite"},{"values":["34"],"additional":true,"name":"Bundweite"}],"category":"Outdoorjacke","productUrl":"http://myproduct.somewhere.com/productname/","bundle":false,"multiPack":true},"pricing":{"sale":{"salePrice":{"amount":19.95,"currency":"EUR"},"endDate":"2019-10-19T09:30:00Z","startDate":"2019-10-19T09:30:00Z"},"normPriceInfo":{"normAmount":100,"normUnit":"g","salesAmount":500,"salesUnit":"g"},"msrp":{"amount":19.95,"currency":"EUR"},"vat":"FULL","standardPrice":{"amount":19.95,"currency":"EUR"}},"order":{"maxOrderQuantity":{"quantity":10,"periodInDays":7}}}],"links":[{"rel":"self","href":".../products?page=0&limit=100"},{"rel":"self","href":".../products?page=0&limit=100"}]},"properties":{"productVariations":{"items":{"$ref":"#/components/schemas/ProductVariation__Products-V3"},"type":"array"},"links":{"description":"a list of links that can be used for pagination.","items":{"$ref":"#/components/schemas/Link__Products-V3"},"type":"array"}},"type":"object"},"Sale__Products-V3":{"example":{"salePrice":{"amount":19.95,"currency":"EUR"},"endDate":"2019-10-19T09:30:00Z","startDate":"2019-10-19T09:30:00Z"},"properties":{"salePrice":{"$ref":"#/components/schemas/MonetaryAmount__Products-V3"},"startDate":{"description":"The start date for the sales.","example":"2019-10-19T09:30:00Z","format":"date-time","type":"string"},"endDate":{"description":"The end date for the sales.","example":"2019-10-19T09:30:00Z","format":"date-time","type":"string"}},"type":"object"},"SkuPricing__Products-V3":{"example":{"sale":{"salePrice":{"amount":19.95,"currency":"EUR"},"endDate":"2019-10-19T09:30:00Z","startDate":"2019-10-19T09:30:00Z"},"standardPrice":{"amount":19.95,"currency":"EUR"},"sku":"sku"},"properties":{"sku":{"description":"The standard price as defined by the partner.","type":"string"},"standardPrice":{"$ref":"#/components/schemas/MonetaryAmount__Products-V3"},"sale":{"$ref":"#/components/schemas/Sale__Products-V3"}},"required":["sku","standardPrice"],"type":"object"},"MaxOrderQuantity__Products-V3":{"description":"The maximum number of items a consumer may order during a specified time period. E.g. max 10 items every 7 days.","example":{"quantity":10,"periodInDays":7},"properties":{"quantity":{"description":"The maximum number of items a consumer may order during a specified time period. Quantity with allowed values from 1 to 50.","example":10,"type":"integer"},"periodInDays":{"description":"The period of time in days during which a consumer may order the specified maximum number of items. Period in days with allowed values from 1 to 90.","example":7,"type":"integer"}},"type":"object"},"Order__Products-V3":{"description":"A Container holding order constraints","example":{"maxOrderQuantity":{"quantity":10,"periodInDays":7}},"properties":{"maxOrderQuantity":{"$ref":"#/components/schemas/MaxOrderQuantity__Products-V3"}},"type":"object"},"ApiErrorResponseV2__Quantities-V2":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","description":"list of errors","items":{"$ref":"#/components/schemas/ApiErrorV2__Quantities-V2"}}},"title":"ApiErrorResponseV2"},"PayloadTooLargeApiErrorResponseV2__Quantities-V2":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","description":"type of error","example":[{"code":413,"detail":"Payload too large","logref":"b35c4ef1-50dd-4765-9bcf-82cde57823d8","path":"/v2/quantities","title":"Error while processing request"}],"items":{"$ref":"#/components/schemas/ApiErrorV2__Quantities-V2"}}},"title":"PayloadTooLargeApiErrorResponseV2"},"ApiErrorV2__Quantities-V2":{"type":"object","required":["code","detail","logref","path","title"],"properties":{"code":{"type":"integer","format":"int32","example":422,"description":"http status code"},"detail":{"type":"string","example":"Details of error message with SKU id","description":"details of the error"},"logref":{"type":"string","example":"b35c4ef1-50dd-4765-9bcf-82cde57823d8","description":"key to find in the log"},"path":{"type":"string","example":"/v2/quantities","description":"api endpoint/uri"},"title":{"type":"string","example":"Error message with SKU id","description":"title of the error"}},"title":"ApiErrorV2"},"AvailableQuantityRequestDTOV2__Quantities-V2":{"type":"object","required":["lastModified","quantity","sku"],"properties":{"lastModified":{"type":"string","example":"2018-12-19T10:00:15.513+0000","description":"The last modified date and time of available quantity as a ISO8601 format (yyyy-MM-dd'T'HH:mm:ss.SSSX). This date should not be neither in future nor older than previous lastModified value from partner. If it is future date/time, then it will lead to an error response. If it is older than previous lastModified value from partner, then the quantity update will be ignored. It is used to ensure the current status of the updated quantities."},"quantity":{"type":"integer","format":"int64","example":123,"description":"The available quantity of a specific SKU, which can be any integer value >= 0.","minimum":0,"maximum":999999999,"exclusiveMinimum":false,"exclusiveMaximum":false},"sku":{"type":"string","example":"123456789ABCDE","description":"StockKeepingUnit given by partner configuration. e.g. 'shirt-red-M', external identifier of article variation."}},"title":"AvailableQuantityRequestDTOV2"},"AvailableQuantityResponseDTOV2__Quantities-V2":{"type":"object","required":["lastModified","quantity","sku","links"],"properties":{"lastModified":{"type":"string","example":"2018-12-19T10:00:15.513+0000","description":"The last modified date and time of available quantity as a ISO8601 format (yyyy-MM-dd'T'HH:mm:ss.SSSX). This date should not be neither in future nor older than previous lastModified value from partner. If it is future date/time, then it will lead to an error response. If it is older than previous lastModified value from partner, then the quantity update will be ignored. It is used to ensure the current status of the updated quantities."},"quantity":{"type":"integer","format":"int64","example":123,"description":"The available quantity of a specific SKU, which can be any integer value >= 0.","minimum":0,"maximum":999999999,"exclusiveMinimum":false,"exclusiveMaximum":false},"sku":{"type":"string","example":"123456789ABCDE","description":"StockKeepingUnit given by partner configuration. e.g. 'shirt-red-M', external identifier of article variation."},"links":{"type":"array","description":"contains links to prev, self and next page url's","items":{"$ref":"#/components/schemas/Link__Quantities-V2"}}},"title":"AvailableQuantityResponseDTOV2"},"AvailableQuantitySingleResponseDTOV2__Quantities-V2":{"type":"object","required":["lastModified","quantity","sku"],"properties":{"lastModified":{"type":"string","example":"2018-12-19T10:00:15.513+0000","description":"The last modified date and time of available quantity as a ISO8601 format (yyyy-MM-dd'T'HH:mm:ss.SSSX). This date should not be neither in future nor older than previous lastModified value from partner. If it is future date/time, then it will lead to an error response. If it is older than previous lastModified value from partner, then the quantity update will be ignored. It is used to ensure the current status of the updated quantities."},"quantity":{"type":"integer","format":"int64","example":123,"description":"The available quantity of a specific SKU, which can be any integer value >= 0.","minimum":0,"maximum":999999999,"exclusiveMinimum":false,"exclusiveMaximum":false},"sku":{"type":"string","example":"123456789ABCDE","description":"StockKeepingUnit given by partner configuration. e.g. 'shirt-red-M', external identifier of article variation."}},"title":"AvailableQuantitySingleResponseDTOV2"},"UpdateQuantityMultiStatusResponse__Quantities-V2":{"type":"object","required":["results"],"properties":{"results":{"type":"array","example":[{"lastModified":"2018-12-19T10:00:15.513+0000","quantity":"123","sku":"4007781056144"}],"description":"List of all the skus with available quantity","items":{"$ref":"#/components/schemas/AvailableQuantityRequestDTOV2__Quantities-V2"}},"errors":{"type":"array","example":[{"path":"/v2/quantities","title":"Error while processing request: sku","code":"207","detail":"Error: SKU is unknown for SKU: sku","logref":"sku"},{"path":"/v2/quantities","title":"Error while processing request: sku","code":"207","detail":"Invalid quantity. Quantity should be an absolute number for SKU: sku","logref":"sku"},{"path":"/v2/quantities","title":"Error while processing request: null","code":"207","detail":"Error: [sku must not be empty] for SKU: null","logref":"sku"}],"items":{"$ref":"#/components/schemas/ApiErrorV2__Quantities-V2"}}},"title":"UpdateQuantityMultiStatusResponse"},"AvailableQuantityResponseV2__Quantities-V2":{"type":"object","required":["resources","links"],"properties":{"resources":{"type":"object","required":["variations"],"properties":{"variations":{"type":"array","example":[{"lastModified":"2018-12-19T10:00:15.513+0000","quantity":"123","sku":"MOCK-CABINET-1","links":[{"rel":"self","href":"/v2/quantities/MOCK-CABINET-1"}]},{"lastModified":"2018-12-19T10:00:15.513+0000","quantity":"123","sku":"SANDWICH-1","links":[{"rel":"self","href":"/v2/quantities/SANDWICH-1"}]}],"items":{"$ref":"#/components/schemas/AvailableQuantityResponseDTOV2__Quantities-V2"}}}},"links":{"type":"array","description":"contains links to prev, self and next page url's","example":[{"rel":"prev","href":"/v2/quantities?limit=2&page=0"},{"rel":"self","href":"/v2/quantities?limit=2&page=1&cursor=null"},{"rel":"next","href":"/v2/quantities?limit=2&page=2&cursor=SANDWICH-1"}],"items":{"$ref":"#/components/schemas/Link__Quantities-V2"}}},"title":"AvailableQuantityRequestDTOV2"},"Link__Quantities-V2":{"type":"object","properties":{"rel":{"type":"string","example":"self","description":"link relation type","enum":["self","prev","next"]},"href":{"type":"string","example":".../v2/quantities?limit=200&page=0","description":"the linked reference as URI"}}},"Address__Orders-V4":{"type":"object","description":"Address","example":null,"properties":{"addition":{"type":"string","description":"The addition","example":"Hinterm Haus"},"city":{"type":"string","description":"The city","example":"Musterstadt"},"countryCode":{"type":"string","description":"The country in SO-3166-1 Alpha-3 format","example":"DEU"},"email":{"type":"string","description":"The e-mail address; if part of the invoice address it's a pseudonymized e-mail address ","example":"test@example.com"},"firstName":{"type":"string","description":"The firstName","example":"Max"},"houseNumber":{"type":"string","description":"The house number","example":"17"},"lastName":{"type":"string","description":"The lastName","example":"Mustermann"},"phoneNumber":{"type":"string","description":"The phone number","example":"0491234567890"},"salutation":{"type":"string","description":"The salutation (MR, MS, COMPANY, UNKNOWN)","example":"MR"},"street":{"type":"string","description":"The street","example":"Musterstraße"},"title":{"type":"string","description":"The title","example":"Dr."},"zipCode":{"type":"string","description":"The zipCode","example":"12345"}},"required":["city","countryCode","firstName","houseNumber","lastName","salutation","street","zipCode"],"title":"Address"},"Amount__Orders-V4":{"type":"object","description":"Amount","example":null,"properties":{"amount":{"type":"number","description":"The amount","example":15.99},"currency":{"type":"string","description":"The currency in ISO_4217 format","example":"EUR"}},"required":["amount","currency"]},"Dimension__Orders-V4":{"type":"object","description":"Dimension","example":null,"properties":{"displayName":{"type":"string","description":"The type description written out for displaying purposes","example":"Farbe"},"type":{"type":"string","description":"The standardized type description","example":"color"},"value":{"type":"string","description":"The actual value of the dimension","example":"schwarz"}},"title":"Dimension"},"InitialDeliveryFee__Orders-V4":{"type":"object","description":"InitialDeliveryFee","example":null,"properties":{"deliveryFeeAmount":{"$ref":"#/components/schemas/Amount__Orders-V4"},"name":{"type":"string","description":"The type of this delivery fee","example":"DELIVERY_FEE_STANDARD"},"positionItemIds":{"type":"array","description":"The position item ids to which this delivery fee applies","example":["1cdef481-683c-4a4c-bf42-fa7f6bb00933","09532b32-6f4e-4277-988b-f5f721ca13c4"],"items":{"type":"string","description":"The position item ids to which this delivery fee applies","example":"[\"1cdef481-683c-4a4c-bf42-fa7f6bb00933\",\"09532b32-6f4e-4277-988b-f5f721ca13c4\"]"}},"vatRate":{"type":"number","description":"The VAT rate for this delivery fee","example":19}},"required":["deliveryFeeAmount","name","positionItemIds","vatRate"],"title":"InitialDeliveryFee"},"InitialDiscount__Orders-V4":{"type":"object","description":"InitialDiscount","example":null,"properties":{"discountAmount":{"$ref":"#/components/schemas/Amount__Orders-V4"},"discountId":{"type":"string","description":"The id of this discount","example":"9978"},"discountName":{"type":"string","description":"The name of this discount","example":"15% auf Technik"},"name":{"type":"string","description":"The type of this discount","example":"DISCOUNT"},"positionItemIds":{"type":"array","description":"The position item ids to which this discount applies","example":["1cdef481-683c-4a4c-bf42-fa7f6bb00933","09532b32-6f4e-4277-988b-f5f721ca13c4"],"items":{"type":"string","description":"The position item ids to which this discount applies","example":"[\"1cdef481-683c-4a4c-bf42-fa7f6bb00933\",\"09532b32-6f4e-4277-988b-f5f721ca13c4\"]"}},"vatRate":{"type":"number","description":"The VAT rate for this discount","example":19}},"required":["discountAmount","discountId","discountName","name","positionItemIds","vatRate"],"title":"InitialDiscount"},"Link__Orders-V4":{"type":"object","description":"A link to various resources. A link can have different meanings and targets. The type of relation is specified with the property 'rel'.","example":null,"properties":{"href":{"type":"string","description":"The url of the link","example":"/v4/orders/12345678,/v4/orders/?nextCursor=bsdjfvbkjdfv"},"rel":{"type":"string","description":"The relation type of the link. See also https://www.iana.org/assignments/link-relations/link-relations.xhtml. The relation type 'next' is used for paging. The relation type 'self' refers to the url of the resource","example":"next,self,describedby"}},"title":"Link"},"OrderLifecycleInformation__Orders-V4":{"type":"object","description":"OrderLifecycleInformation","example":null,"properties":{"lifecycleChangeDate":{"type":"string","format":"date-time","description":"The date, when this order has been placed","example":null}},"required":["lifecycleChangeDate"],"title":"OrderLifecycleInformation"},"PartnerOrder__Orders-V4":{"type":"object","example":null,"properties":{"deliveryAddress":{"$ref":"#/components/schemas/Address__Orders-V4"},"initialDeliveryFees":{"type":"array","description":"The delivery fees on customer checkout","example":null,"items":{"$ref":"#/components/schemas/InitialDeliveryFee__Orders-V4"}},"initialDiscounts":{"type":"array","description":"The initial discounts on customer checkout","example":null,"items":{"$ref":"#/components/schemas/InitialDiscount__Orders-V4"}},"invoiceAddress":{"$ref":"#/components/schemas/Address__Orders-V4"},"lastModifiedDate":{"type":"string","format":"date-time","description":"Last order update date","example":null},"links":{"type":"array","description":"Order related links like the link to fetch the single partner order","example":null,"items":{"$ref":"#/components/schemas/Link__Orders-V4"}},"orderDate":{"type":"string","format":"date-time","description":"The date, when this order has been placed","example":null},"orderLifecycleInformation":{"$ref":"#/components/schemas/OrderLifecycleInformation__Orders-V4"},"orderNumber":{"type":"string","description":"The order number. An unique human readable 10 character(alphanumeric) identifier referring to this order ","example":"p982bht4t29"},"payment":{"$ref":"#/components/schemas/Payment__Orders-V4"},"positionItems":{"type":"array","description":"The physical position items of this order. Multiple position item can refer to the same product","example":null,"items":{"$ref":"#/components/schemas/PositionItem__Orders-V4"}},"salesOrderId":{"type":"string","description":"The id of the corresponding sales order. For one partner the sales order id is unique","example":"9864623c-42a4-4892-9270-cd733d32362e"}},"required":["orderDate","orderLifecycleInformation","orderNumber","positionItems","salesOrderId"],"title":"PartnerOrder"},"PartnerOrderList__Orders-V4":{"type":"object","example":null,"properties":{"links":{"type":"array","description":"Links related to the list. E.g. the link to the successive list used during paging.","example":null,"items":{"$ref":"#/components/schemas/Link__Orders-V4"}},"resources":{"type":"array","description":"The list of queried resources. In this case partner orders.","example":null,"items":{"$ref":"#/components/schemas/PartnerOrder__Orders-V4"}}},"title":"PartnerOrderList"},"Payment__Orders-V4":{"type":"object","description":"Payment","example":null,"properties":{"paymentMethod":{"type":"string","description":"The payment method. Values currently in use are \"INVOICE_SINGLE\", \"INVOICE_INSTALLMENTS\", \"PREPAYMENT\", \"DIRECT_DEBIT\", \"DIRECT_DEBIT_INSTALLMENTS\", \"CREDIT_CARD_ONLINE\", \"PAYPAL\". These values are subject to change.","example":"INVOICE_SINGLE"}},"required":["paymentMethod"],"title":"Payment"},"PositionItem__Orders-V4":{"type":"object","description":"PositionItem","example":null,"properties":{"cancellationDate":{"type":"string","format":"date-time","description":"Date the position item was cancelled","example":null},"cancellationReason":{"type":"string","description":"Reason why a position was cancelled","enum":["CANCELLED_ON_CUSTOMER_WISH","CANCELLED_ON_PARTNER_WISH","PAYMENT_ABORTED"],"example":null},"deliveryServiceHes":{"type":"boolean","description":"Position item has delivery service HES","example":null},"expectedDeliveryDate":{"type":"string","format":"date-time","description":"The date the position item should be delivered","example":"2018-10-30T12:00:00+01:00"},"fulfillmentStatus":{"type":"string","description":"The fulfillment status of the position item","enum":["ANNOUNCED","PROCESSABLE","SENT","RETURNED","CANCELLED_BY_PARTNER","CANCELLED_BY_MARKETPLACE"],"example":null},"itemValueDiscount":{"$ref":"#/components/schemas/Amount__Orders-V4"},"itemValueGrossPrice":{"$ref":"#/components/schemas/Amount__Orders-V4"},"itemValueReducedGrossPrice":{"$ref":"#/components/schemas/Amount__Orders-V4"},"positionItemId":{"type":"string","description":"The unique id of the position item","example":"7323981b-14b4-7123-7812-ac783d98132c"},"processableDate":{"type":"string","format":"date-time","description":"Date the position item has reached PROCESSABLE fulfillment status","example":null},"product":{"$ref":"#/components/schemas/Product__Orders-V4"},"returnedDate":{"type":"string","format":"date-time","description":"Date the position item was returned","example":null},"sentDate":{"type":"string","format":"date-time","description":"Date the position item was sent","example":null},"trackingInfo":{"$ref":"#/components/schemas/TrackingInfo__Orders-V4"},"weeePickup":{"type":"boolean","description":"Position item has electrical and electronic equipment disposal service (WEEE)","example":null}},"required":["fulfillmentStatus","itemValueGrossPrice","positionItemId","product"],"title":"PositionItem"},"Product__Orders-V4":{"type":"object","description":"Product","example":null,"properties":{"articleNumber":{"type":"string","description":"The external identifier of the product, it is shown as \"article number\" on the product detail page of otto.de to the customer.","example":"S000003AXQU"},"dimensions":{"type":"array","description":"List of dimensions that are individual for each product type","example":null,"items":{"$ref":"#/components/schemas/Dimension__Orders-V4"}},"ean":{"type":"string","description":"EAN number of this product","example":"233232323"},"productTitle":{"type":"string","description":"The title of this product","example":"Black T-Shirt"},"sku":{"type":"string","description":"The external identifier of the variation, uniquely identifies a variation in partner cataloq","example":"13033"},"vatRate":{"type":"number","description":"The VAT rate for ordered products and shipping costs","example":19}},"required":["articleNumber","productTitle","sku","vatRate"],"title":"Product"},"TrackingInfo__Orders-V4":{"type":"object","description":"TrackingInfo","example":null,"properties":{"carrier":{"type":"string","description":"The name of the carrier","example":"DHL"},"carrierServiceCode":{"type":"string","description":"The service code provided by the carrier","example":null},"trackingNumber":{"type":"string","description":"The tracking number provided by the carrier","example":"H1234567890123456789"}},"title":"TrackingInfo"},"TrackingKey__ReturnShipments-V1":{"type":"object","required":["carrier","trackingNumber"],"properties":{"carrier":{"description":"The carrier of the returnShipment.","type":"string","enum":["DHL","GLS","HERMES","HES"]},"trackingNumber":{"description":"The tracking number assigned by the carrier.","type":"string"}},"title":"TrackingKey","example":{"carrier":"HERMES","trackingNumber":"H1234567890123456789"}},"ReturnPositionItem__ReturnShipments-V1":{"description":"A single position item.","type":"object","required":["salesOrderId","salesOrderPositionItemId"],"properties":{"salesOrderId":{"description":"The ID of the sales order from the OTTO Market, as defined in the Order API.","type":"string","format":"uuid","example":"a46fb35b-9c77-41c9-af10-2676b756a9af"},"salesOrderPositionItemId":{"description":"The ID of a position item of the sales order from the OTTO Market, as defined in the Order API.","format":"uuid","type":"string","example":"e454dff5-a96f-4e96-9399-710cf59645c2"}},"title":"ReturnPositionItem"},"ReturnShipmentState__ReturnShipments-V1":{"type":"object","required":["state","occurredOn"],"properties":{"state":{"description":"The tracking state of the returnShipment.","type":"string","enum":["ANNOUNCED","ON_THE_WAY","DELIVERED"]},"occurredOn":{"type":"string","example":"2022-05-01T07:49:12.642Z"},"statusText":{"description":"Optional information from the carrier detailing the tracking state.","type":"string","example":"Retoure am PaketShop abgegeben"}}},"ReturnShipment__ReturnShipments-V1":{"description":"A returnShipment with full details.","type":"object","required":["returnShipmentId","createdAt","trackingKey","returnPositionItems"],"properties":{"returnShipmentId":{"description":"Internal returnShipment identifier assigned by OTTO Market.","type":"string","example":"602392a2e5c50d0cbfb18a6b"},"createdAt":{"type":"string","example":"2022-05-01T07:49:12.642Z"},"trackingKey":{"$ref":"#/components/schemas/TrackingKey__ReturnShipments-V1"},"returnPositionItems":{"description":"The position items included in the returnShipment.","minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ReturnPositionItem__ReturnShipments-V1"}},"states":{"description":"The history of tracking states of the returnShipment","minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ReturnShipmentState__ReturnShipments-V1"}}},"title":"ReturnShipment"},"ReturnShipmentList__ReturnShipments-V1":{"type":"object","properties":{"links":{"type":"array","description":"Contains one single link, which can be used as pointer for Cursor-based pagination.","items":{"$ref":"#/components/schemas/Link__ReturnShipments-V1"}},"resources":{"type":"array","items":{"$ref":"#/components/schemas/ReturnShipment__ReturnShipments-V1"}}},"title":"ReturnShipmentList"},"Link__ReturnShipments-V1":{"type":"object","properties":{"href":{"type":"string","example":"/v1/return-shipments?next=12345678&limit=25&datefrom=2019-05-02T07:49:12.642Z","description":"The url of the link"},"rel":{"type":"string","example":"next","description":"The relation type of the link. See also https://www.iana.org/assignments/link-relations/link-relations.xhtml. The relation type 'next' is used for paging. The relation type 'self' refers to the url of the ressource"}},"title":"Link","description":"A link to various resources. a Link can have different meanings and targets. The type of relation is specified with the property 'rel'. "},"Unauthorized__ReturnShipments-V1":{"description":"Authentication is required and has failed."},"ForbiddenGetReturnShipmentByTrackingNumber__ReturnShipments-V1":{"description":"The partner does not have the required permissions.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__ReturnShipments-V1"}},"example":{"errors":[{"title":"INSUFFICIENT_PERMISSION","detail":"The partner is not allowed to get shipment with carrier DHL and tracking number 00340434268030693122","path":"/return-shipments/carriers/DHL/trackingnumbers/00340434268030693122"}]}},"ForbiddenGetReturnShipmentByReturnShipmentId__ReturnShipments-V1":{"description":"The partner does not have the required permissions.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__ReturnShipments-V1"}},"example":{"errors":[{"title":"INSUFFICIENT_PERMISSION","detail":"The partner is not allowed to get shipment with id 101069930815","path":"/return-shipments/101069930815"}]}},"NotFoundGetReturnShipmentByTrackingNumber__ReturnShipments-V1":{"description":"Server can not find requested resource.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__ReturnShipments-V1"}},"example":{"errors":[{"title":"RESOURCE_NOT_FOUND","detail":"Found no shipment with carrier DHL and tracking number 003404342680306931225","path":"/return-shipments/carriers/DHL/trackingnumbers/003404342680306931225"}]}},"NotFoundGetReturnShipmentByReturnShipmentId__ReturnShipments-V1":{"description":"Server can not find requested resource.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__ReturnShipments-V1"}},"example":{"errors":[{"title":"RESOURCE_NOT_FOUND","detail":"Found no shipment with id 1010699308155","path":"/return-shipments/1010699308155"}]}},"InternalServerErrorGetReturnShipmentList__ReturnShipments-V1":{"description":"An internal server error occurred.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__ReturnShipments-V1"}},"example":{"errors":[{"title":"INTERNAL_SERVER_ERROR","path":"/return-shipments?datefrom=2022-05-01T07:49:12.642Z"}]}},"InternalServerErrorGetReturnShipmentByTrackingNumber__ReturnShipments-V1":{"description":"An internal server error occurred.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__ReturnShipments-V1"}},"example":{"errors":[{"title":"INTERNAL_SERVER_ERROR","path":"/return-shipments/carriers/DHL/trackingnumbers/00340434268030693122"}]}},"InternalServerErrorGetReturnShipmentByReturnShipmentId__ReturnShipments-V1":{"description":"An internal server error occurred.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__ReturnShipments-V1"}},"example":{"errors":[{"title":"INTERNAL_SERVER_ERROR","path":"/return-shipments/101069930815"}]}},"ErrorDescription__ReturnShipments-V1":{"description":"Describes one single error.","type":"object","required":["title","path"],"properties":{"title":{"description":"The short description of the error.","type":"string"},"detail":{"description":"The long description of the error.","type":"string"},"path":{"description":"The called REST path.","type":"string"},"jsonPath":{"description":"The JSON path points either to the object or the value that caused the error. The JSON path could consists of JSON properties and indexes.","type":"string","example":"trackingKey.trackingNumber"}}},"Address__Shipments-V1":{"type":"object","required":["city","countryCode","zipCode"],"properties":{"city":{"type":"string","example":"Dresden","description":"The city from where the shipment is sent.","minLength":1,"maxLength":60},"countryCode":{"type":"string","example":"DEU","pattern":"^[A-Z]{3}$","description":"The country code according to [iso-3166-1-alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) from where the shipment is sent."},"zipCode":{"type":"string","example":"01067","description":"The zip code from where the shipment is sent.","minLength":1,"maxLength":10}},"title":"Address","description":"The warehouse or location from which the shipment will be picked up for final delivery."},"CreateShipmentRequest__Shipments-V1":{"type":"object","required":["shipDate","shipFromAddress","positionItems","trackingKey"],"properties":{"trackingKey":{"$ref":"#/components/schemas/TrackingKey__Shipments-V1"},"shipDate":{"type":"string","format":"date-time","description":"The date that the shipment is handed over to the carrier. Must be a valid UTC dateTime according to ISO 8601.","example":"2019-10-11T07:49:12.642Z"},"shipFromAddress":{"$ref":"#/components/schemas/Address__Shipments-V1"},"positionItems":{"description":"The position items included in shipment.","minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PositionItem__Shipments-V1"},"example":[{"positionItemId":"b01b8ad2-a49c-47fc-8ade-8629ec000020","salesOrderId":"bf43d748-f13d-49ca-b2e2-1824e9000021","returnTrackingKey":{"carrier":"DHL","trackingNumber":"577546565072"}},{"positionItemId":"b01b8ad2-a49c-47fc-8ade-8629ec000022","salesOrderId":"bf43d748-f13d-49ca-b2e2-1824e9000021","returnTrackingKey":{"carrier":"DHL","trackingNumber":"577546565072"}}]}},"title":"CreateShipmentRequest"},"CreateShipmentResponse__Shipments-V1":{"type":"object","properties":{"shipmentId":{"description":"Internal shipment identifier assigned by OTTO Market.","type":"string","example":"100000294699"}},"title":"CreateShipmentResponse"},"CreateMultiparcelShipmentRequest__Shipments-V1":{"minItems":2,"type":"array","items":{"$ref":"#/components/schemas/CreateShipmentRequest__Shipments-V1"},"title":"CreateMultiparcelShipmentRequest"},"CreateMultiparcelShipmentResponse__Shipments-V1":{"type":"object","properties":{"multiParcelShipmentId":{"description":"Internal multiparcel shipment identifier assigned by OTTO Market.","type":"string","example":"100000294699"}},"title":"CreateMultiparcelShipmentResponse"},"PositionItem__Shipments-V1":{"description":"A single position item.","type":"object","required":["positionItemId","salesOrderId","returnTrackingKey"],"properties":{"positionItemId":{"description":"The ID of a position item of the sales order from the OTTO Market, as defined in the Order API.","format":"uuid","type":"string","example":"e454dff5-a96f-4e96-9399-710cf59645c2"},"salesOrderId":{"description":"The ID of the sales order from the OTTO Market, as defined in the Order API.","type":"string","format":"uuid","example":"a46fb35b-9c77-41c9-af10-2676b756a9af"},"returnTrackingKey":{"$ref":"#/components/schemas/ReturnTrackingKey__Shipments-V1"}},"title":"PositionItem"},"ShipmentState__Shipments-V1":{"type":"object","required":["state","occurredOn"],"properties":{"state":{"description":"The tracking state of the shipment.","type":"string","enum":["SENT","ON_THE_WAY","DELIVERED","DELIVERED_FOR_PICKUP","DELIVERY_ATTEMPT_FAILED"]},"occurredOn":{"type":"string","example":"2022-05-01T07:49:12.642Z"}}},"ReturnTrackingKey__Shipments-V1":{"description":"The return tracking key for the return process.
**Required for parcel deliveries.**
**Optional for forwarder deliveries.**
Each position item can have its own return tracking key.","type":"object","required":["carrier","trackingNumber"],"properties":{"carrier":{"description":"The carrier for the return process, which can differ from the carrier used to deliver the shipment to the customer. Please be aware that this carrier can not differ from the chosen carrier in the OPC portal.","type":"string","enum":["DHL","GLS","HERMES"]},"trackingNumber":{"description":"The tracking number (or return tracking number) assigned by the carrier.","type":"string"}},"title":"ReturnTrackingKey","example":{"carrier":"DHL","trackingNumber":"577546565072"}},"Shipment__Shipments-V1":{"description":"A shipment with full details.","type":"object","properties":{"shipmentId":{"description":"Internal shipment identifier assigned by OTTO Market.","type":"string","example":"101068391469"},"creationDate":{"type":"string","example":"2019-10-11T07:49:12.642Z"},"trackingKey":{"$ref":"#/components/schemas/TrackingKey__Shipments-V1"},"shipDate":{"type":"string","example":"2019-09-19T13:00:00.000Z"},"shipFromAddress":{"$ref":"#/components/schemas/Address__Shipments-V1"},"positionItems":{"description":"The position items included in the shipment.","minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PositionItem__Shipments-V1"}},"states":{"description":"The history of tracking states of the shipment","minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ShipmentState__Shipments-V1"}}},"title":"Shipment"},"ShipmentList__Shipments-V1":{"type":"object","properties":{"links":{"type":"array","description":"Contains one single link, which can be used as pointer for Cursor-based pagination.","items":{"$ref":"#/components/schemas/Link__Shipments-V1"}},"resources":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentWithMinimumDetails__Shipments-V1"}}},"title":"ShipmentList"},"Link__Shipments-V1":{"type":"object","properties":{"href":{"type":"string","example":"/v1/shipments?next=12345678&limit=25&datefrom=2019-05-02","description":"The url of the link"},"rel":{"type":"string","example":"next","description":"The relation type of the link. See also https://www.iana.org/assignments/link-relations/link-relations.xhtml. The relation type 'next' is used for paging. The relation type 'self' refers to the url of the ressource"}},"title":"Link","description":"A link to various resources. a Link can have different meanings and targets. The type of relation is specified with the property 'rel'. "},"ShipmentWithMinimumDetails__Shipments-V1":{"description":"A shipment with a reduced number of fields.","type":"object","properties":{"creationDate":{"type":"string","example":"2019-10-11T07:49:12.642Z"},"shipmentId":{"description":"Internal shipment identifier assigned by OTTO Market.","type":"string","example":"101068626890"},"trackingKey":{"$ref":"#/components/schemas/TrackingKey__Shipments-V1"},"states":{"description":"The history of tracking states of the shipment","minItems":0,"type":"array","items":{"$ref":"#/components/schemas/ShipmentState__Shipments-V1"}}},"title":"ShipmentWithMinimumDetails"},"TrackingKey__Shipments-V1":{"type":"object","required":["carrier","trackingNumber"],"properties":{"carrier":{"description":"The carrier of the shipment.","type":"string","enum":["DHL","DHL_FREIGHT","DHL_HOME_DELIVERY","GLS","HERMES","DPD","UPS","HES","HELLMANN","DB_SCHENKER","IDS","EMONS","DACHSER","LOGWIN","KUEHNE_NAGEL","SCHOCKEMOEHLE","KOCH","REITHMEIER","CARGOLINE","BURSPED","GEL","DHL_EXPRESS","MEYER_JUMBO","BTW","RHENUS","OTHER_FORWARDER"]},"trackingNumber":{"description":"The tracking number assigned by the carrier.
Required for parcel deliveries.
Optional for forwarder deliveries.","type":"string"}},"title":"TrackingKey","example":{"carrier":"HERMES","trackingNumber":"H1234567890123456789"}},"BadRequest__Shipments-V1":{"description":"The partner sent a bad request.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}}},"BadRequestAddPositionItemByTrackingNumber__Shipments-V1":{"description":"The partner sent a bad request.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}}},"BadRequestAddPositionItemByShipmentId__Shipments-V1":{"description":"The partner sent a bad request.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}}},"Unauthorized__Shipments-V1":{"description":"Authentication is required and has failed."},"ForbiddenGetShipmentByTrackingNumber__Shipments-V1":{"description":"The partner does not have the required permissions.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"INSUFFICIENT_PERMISSION","detail":"The partner is not allowed to get shipment with carrier DHL and tracking number 00340434268030693122","path":"/shipments/carriers/DHL/trackingnumbers/00340434268030693122"}]}},"ForbiddenGetShipmentByShipmentId__Shipments-V1":{"description":"The partner does not have the required permissions.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"INSUFFICIENT_PERMISSION","detail":"The partner is not allowed to get shipment with id 101069930815","path":"/shipments/101069930815"}]}},"NotFoundGetShipmentByTrackingNumber__Shipments-V1":{"description":"Server can not find requested resource.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"RESOURCE_NOT_FOUND","detail":"Found no shipment with carrier DHL and tracking number 003404342680306931225","path":"/shipments/carriers/DHL/trackingnumbers/003404342680306931225"}]}},"NotFoundGetShipmentByShipmentId__Shipments-V1":{"description":"Server can not find requested resource.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"RESOURCE_NOT_FOUND","detail":"Found no shipment with id 1010699308155","path":"/shipments/1010699308155"}]}},"NotFoundAddPositionItemByTrackingNumber__Shipments-V1":{"description":"Server can not find requested resource.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"RESOURCE_NOT_FOUND","detail":"Found no shipment with carrier DHL and tracking number 003404342680306931252","path":"/shipments/carriers/DHL/trackingnumbers/003404342680306931252/positionitems"}]}},"NotFoundAddPositionItemByShipmentId__Shipments-V1":{"description":"Server can not find requested resource.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"RESOURCE_NOT_FOUND","detail":"Found no shipment with id 1010699308155","path":"/shipments/1010699308155/positionitems"}]}},"Conflict__Shipments-V1":{"description":"The request could not be completed due to a conflict with the current state of the target resource. The client should not repeat this request without modification.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"DUPLICATE_TRACKING_KEY","detail":"Tracking key already exists for another shipment.","path":"/shipments"}]}},"ConflictMultiparcel__Shipments-V1":{"description":"The request could not be completed due to a conflict with the current state of the target resource. The client should not repeat this request without modification.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"DUPLICATE_TRACKING_KEY","detail":"Tracking key already exists for another shipment.","path":"/multiparcel-shipments[0].shipments"}]}},"ConflictAddPositionItemByTrackingNumber__Shipments-V1":{"description":"The request could not be completed due to a conflict with the current state of the target resource. The client should not repeat this request without modification.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"POSITION_ITEM_INCLUDED_IN_OTHER_SHIPMENT","detail":"One or more of the given position item ids already exist in another shipment","path":"/shipments/carriers/DHL/trackingnumbers/00340434268030693122/positionitems"}]}},"ConflictAddPositionItemByShipmentId__Shipments-V1":{"description":"The request could not be completed due to a conflict with the current state of the target resource. The client should not repeat this request without modification.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"POSITION_ITEM_INCLUDED_IN_OTHER_SHIPMENT","detail":"One or more of the given position item ids already exist in another shipment","path":"/shipments/101069930815/positionitems"}]}},"InternalServerError__Shipments-V1":{"description":"An internal server error occurred.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"INTERNAL_SERVER_ERROR","path":"/shipments"}]}},"InternalServerErrorMultiparcel__Shipments-V1":{"description":"An internal server error occurred.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"INTERNAL_SERVER_ERROR","path":"/multiparcel-shipments"}]}},"InternalServerErrorGetShipmentList__Shipments-V1":{"description":"An internal server error occurred.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"INTERNAL_SERVER_ERROR","path":"/shipments?datefrom=2019-10-10"}]}},"InternalServerErrorGetShipmentByTrackingNumber__Shipments-V1":{"description":"An internal server error occurred.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"INTERNAL_SERVER_ERROR","path":"shipments/carriers/DHL/trackingnumbers/00340434268030693122"}]}},"InternalServerErrorGetShipmentByShipmentId__Shipments-V1":{"description":"An internal server error occurred.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"INTERNAL_SERVER_ERROR","path":"/shipments/101069930815"}]}},"InternalServerErrorAddPositionItemByTrackingNumber__Shipments-V1":{"description":"An internal server error occurred.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"INTERNAL_SERVER_ERROR","path":"/shipments/carriers/DHL/trackingnumbers/00340434268030693122/positionitem"}]}},"InternalServerErrorAddPositionItemByShipmentId__Shipments-V1":{"description":"An internal server error occurred.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorDescription__Shipments-V1"}},"example":{"errors":[{"title":"INTERNAL_SERVER_ERROR","path":"/shipments/101069930815/positionitems"}]}},"ErrorDescription__Shipments-V1":{"description":"Details of the occurred errors.","type":"object","required":["title","path"],"properties":{"title":{"description":"The short description of the error.","type":"string"},"detail":{"description":"The long description of the error.","type":"string"},"path":{"description":"The called REST path.","type":"string"},"jsonPath":{"description":"The JSON path points either to the object or the value that caused the error. The JSON path could consists of JSON properties and indexes.","type":"string","example":"positionItems[0].returnTrackingKey.trackingNumber"}}},"AcceptedPartnerReturnV2__Returns-V2":{"type":"object","required":["positionItems"],"properties":{"positionItems":{"type":"array","example":[{"positionItemId":"942e2a36-9112-444e-92e3-3bc3cd93011","salesOrderId":"7423afd2-e7ab-4bae-ac30-048b7c0346c1","condition":"A"}],"description":"List of all the items received from partner","items":{"$ref":"#/components/schemas/ReturnedPositionItem__Returns-V2"}}},"title":"AcceptedPartnerReturnV2"},"AcceptedReturnMultiStatusResponse__Returns-V2":{"type":"object","required":["results"],"properties":{"results":{"type":"array","example":[{"positionItemId":"942e2a36-9112-444e-92e3-3bc3cd93011","salesOrderId":"7423afd2-e7ab-4bae-ac30-048b7c0346c1","condition":"A"}],"description":"List of all the items received from partner","items":{"$ref":"#/components/schemas/ReturnedPositionItem__Returns-V2"}},"errors":{"type":"array","example":[{"path":"/v2/returns/acceptance","title":"Error message with positionItemId","code":"207","detail":"details of error with positionItemId","logref":"positionItemId"},{"path":"/v2/returns/acceptance","title":"Error while processing request: positionItemId","code":"207","detail":"Error: Product Not Sent By The Partner for positionItemId: positionItemId","logref":"positionItemId"},{"path":"/v2/returns/acceptance","title":"Error while processing request: positionItemId","code":"207","detail":"Error: Product Does Not Belong To Sales Order Id for positionItemId: positionItemId","logref":"positionItemId"},{"path":"/v2/returns/acceptance","title":"Error while processing request: positionItemId","code":"207","detail":"Product Is Already Accepted By The Partner for positionItemId: positionItemId","logref":"positionItemId"}],"items":{"$ref":"#/components/schemas/ApiError__Returns-V2"}}},"title":"AcceptedReturnMultiStatusResponse"},"AcceptedStatusData__Returns-V2":{"title":"AcceptedStatusData","allOf":[{"$ref":"#/components/schemas/ReturnedItemStatusData__Returns-V2"},{"type":"object","properties":{"condition":{"type":"string","example":"A for originalverpackt / in original packaging; B for wie neu / in mint condition; C for leicht gebraucht / slightly used; D for stark gebraucht / heavily used; E for Irrtum (Ware unvollständig, nicht vorhanden, …) / mistake (Delivery incomplete, not available,...)","description":"Condition of the returned item"}},"title":"AcceptedStatusData","description":"Details specific to a 'accepted' return status."}],"description":"Details specific to a 'accepted' return status."},"AnnouncedStatusData__Returns-V2":{"title":"AnnouncedStatusData","allOf":[{"$ref":"#/components/schemas/ReturnedItemStatusData__Returns-V2"},{"type":"object","properties":{"returnTrackingKey":{"$ref":"#/components/schemas/ReturnTrackingKey__Returns-V2"}},"title":"AnnouncedStatusData","description":"Details specific to a 'announced' return status."}],"description":"Details specific to a 'announced' return status."},"ApiError__Returns-V2":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"detail":{"type":"string"},"logref":{"type":"string"},"path":{"type":"string"},"title":{"type":"string"}},"title":"ApiError"},"ApiErrorResponse__Returns-V2":{"type":"object","properties":{"errors":{"type":"array","example":[{"path":"/v2/returns/rejection | /v2/returns/acceptance","title":"Error message with positionItemId","code":"422|401|413|400","detail":"details of error with positionItemId","logref":"positionItemId"}],"description":"List of all the items received from partner","items":{"$ref":"#/components/schemas/ApiError__Returns-V2"}}},"title":"ApiErrorResponse"},"Link__Returns-V2":{"type":"object","properties":{"href":{"type":"string","example":"/v2/returns?status=Misdirected","description":"The url of the link"},"rel":{"type":"string","example":"next","description":"The relation type of the link. See also https://www.iana.org/assignments/link-relations/link-relations.xhtml. The relation type 'next' is used for paging. The relation type 'self' refers to the url of the resource"}},"title":"Link","description":"A link to various resources. A Link can have different meanings and targets. The type of relation is specified with the property 'rel'. "},"MisdirectedStatusData__Returns-V2":{"title":"MisdirectedStatusData","allOf":[{"$ref":"#/components/schemas/ReturnedItemStatusData__Returns-V2"},{"type":"object","properties":{"orderNumber":{"type":"string","example":"b7c0346c1","description":"Order Number"},"ottoWarehouseID":{"type":"string","example":"e4fae5b7e4fae5b7d4","description":"This is the unique id which helps partner identify the misdirected item"}},"title":"MisdirectedStatusData","description":"Details specific to a 'misdirected' return status."}],"description":"Details specific to a 'misdirected' return status."},"PositionItem__Returns-V2":{"type":"object","properties":{"positionItemId":{"type":"string","example":"7423afd2-e7ab-4bae-ac30-048b7c0346c1","description":"Sales position item ID"},"salesOrderId":{"type":"string","example":"7423afd2-e7ab-4bae-ac30-048b7c0346c1","description":"Sales order ID"},"status":{"type":"string","example":"MISDIRECTED","description":"Current return status of item.","enum":["ANNOUNCED","ACCEPTED","REJECTED","MISDIRECTED"]},"occurredTime":{"type":"string","example":"2019-08-04T22:00:00.00Z","description":"Date when the last status was updated."},"details":{"$ref":"#/components/schemas/ReturnedItemStatusData__Returns-V2"}},"title":"PositionItem","description":"Details about a positionItem."},"PositionItemList__Returns-V2":{"type":"object","properties":{"positionItems":{"type":"array","description":"The list of queried items.","items":{"$ref":"#/components/schemas/PositionItem__Returns-V2"}},"links":{"type":"array","description":"Links related to the list. E.g. the link to the successive list used during paging.","items":{"$ref":"#/components/schemas/Link__Returns-V2"}}},"title":"PositionItemList"},"RejectedPartnerReturnV2__Returns-V2":{"type":"object","required":["positionItems"],"properties":{"positionItems":{"type":"array","example":[{"positionItemId":"942e2a36-9112-444e-92e3-3bc3cd93011","salesOrderId":"7423afd2-e7ab-4bae-ac30-048b7c0346c1","condition":"A","reason":"bad quality"}],"description":"List of all the items received from partner","items":{"$ref":"#/components/schemas/RejectedPositionItem__Returns-V2"}}},"title":"RejectedPartnerReturnV2"},"RejectedPositionItem__Returns-V2":{"type":"object","required":["positionItemId","reason","salesOrderId"],"properties":{"positionItemId":{"type":"string","example":"76737ae6-c316-4880-b1ff-a1a92b4866e9","description":"Sales position item ID"},"salesOrderId":{"type":"string","example":"ff2e3713-e28e-492c-b6cd-d076e4b68ef5","description":"Sales order ID"},"condition":{"type":"string","example":"A for originalverpackt / in original packaging; B for wie neu / in mint condition; C for leicht gebraucht / slightly used; D for stark gebraucht / heavily used; E for Irrtum (Ware unvollständig, nicht vorhanden, …) / mistake (Delivery incomplete, not available,...)","description":"Condition of the returned item","enum":["A/B/C/D/E"]},"reason":{"type":"string","example":"Broken Product","description":"Reason for Rejection"}},"title":"RejectedPositionItem"},"RejectedReturnMultiStatusResponse__Returns-V2":{"type":"object","required":["results"],"properties":{"results":{"type":"array","example":[{"positionItemId":"942e2a36-9112-444e-92e3-3bc3cd93011","salesOrderId":"7423afd2-e7ab-4bae-ac30-048b7c0346c1","condition":"A","reason":"bad quality"}],"description":"List of all the items received from partner","items":{"$ref":"#/components/schemas/RejectedPositionItem__Returns-V2"}},"errors":{"type":"array","example":[{"path":"/v2/returns/rejection","title":"Error message with positionItemId","code":"207","detail":"details of error with positionItemId","logref":"positionItemId"},{"path":"/v2/returns/rejection","title":"Error while processing request: positionItemId","code":"207","detail":"Error: Product Not Sent By The Partner for positionItemId: positionItemId","logref":"positionItemId"},{"path":"/v2/returns/rejection","title":"Error while processing request: positionItemId","code":"207","detail":"Error: Product Does Not Belong To Sales Order Id for positionItemId: positionItemId","logref":"positionItemId"},{"path":"/v2/returns/rejection","title":"Error while processing request: positionItemId","code":"207","detail":"Product Is Already Accepted By The Partner for positionItemId: positionItemId","logref":"positionItemId"}],"items":{"$ref":"#/components/schemas/ApiError__Returns-V2"}}},"title":"RejectedReturnMultiStatusResponse"},"RejectedStatusData__Returns-V2":{"title":"RejectedStatusData","allOf":[{"$ref":"#/components/schemas/ReturnedItemStatusData__Returns-V2"},{"type":"object","required":["reason"],"properties":{"condition":{"type":"string","example":"A for originalverpackt / in original packaging; B for wie neu / in mint condition; C for leicht gebraucht / slightly used; D for stark gebraucht / heavily used; E for Irrtum (Ware unvollständig, nicht vorhanden, …) / mistake (Delivery incomplete, not available,...)","description":"Condition of the returned item"},"reason":{"type":"string","example":"Broken Product","description":"Reason for Rejection"}},"title":"RejectedStatusData","description":"Details specific to a 'rejected' return status."}],"description":"Details specific to a 'rejected' return status."},"ReturnTrackingKey__Returns-V2":{"title":"ReturnTrackingKey","allOf":[{"$ref":"#/components/schemas/ReturnedItemStatusData__Returns-V2"},{"type":"object","properties":{"trackingNumbers":{"type":"array","example":["40327653113+99000900090001902","40327653113+99000900090001903"],"description":"The list of return tracking numbers for the announced item","items":{"type":"string"}},"carrier":{"type":"string","example":"DHL","description":"The carrier for the announced item"}},"title":"ReturnTrackingKey"}]},"ReturnedItemStatusData__Returns-V2":{"type":"object","title":"ReturnedItemStatusData","description":"UnionType: One of ReturnAnnounced, Misdirected Return, Accepted Return, Rejected Return. This type is never returned to the client only the subtypes are"},"ReturnedPositionItem__Returns-V2":{"type":"object","required":["positionItemId","salesOrderId"],"properties":{"positionItemId":{"type":"string","example":"76737ae6-c316-4880-b1ff-a1a92b4866e9","description":"Sales position item ID"},"salesOrderId":{"type":"string","example":"ff2e3713-e28e-492c-b6cd-d076e4b68ef5","description":"Sales order ID"},"condition":{"type":"string","example":"A for originalverpackt / in original packaging; B for wie neu / in mint condition; C for leicht gebraucht / slightly used; D for stark gebraucht / heavily used; E for Irrtum (Ware unvollständig, nicht vorhanden, …) / mistake (Delivery incomplete, not available,...)","description":"Condition of the returned item","enum":["A/B/C/D/E"]}},"title":"ReturnedPositionItem"},"Address__Receipts-V3":{"title":"Address","required":["city","countryCode","firstName","lastName","street","zipCode"],"type":"object","properties":{"firstName":{"type":"string","description":"First name of person or name of a pick point","example":"Iris"},"lastName":{"type":"string","description":"Last name of a person or a pick point id","example":"Muster"},"street":{"type":"string","description":"Street of address.
For sales orders were placed before 23rd Sep. 2021 street and house number are both parts of this field","example":"Washingtonallee"},"houseNumber":{"type":"string","description":"House number of address
Available for sales orders placed after 23rd Sep. 2021. For older sales orders the house number is part of the field street and this field is not shown at all","example":"42"},"addition":{"type":"string","description":"Additional information of the address
Can be used to provide additional information of address","example":"Hinterhof, 1. Stock"},"zipCode":{"type":"string","description":"Zip code of address","example":"22885"},"city":{"type":"string","description":"City of address","example":"Bremerhaven"},"countryCode":{"type":"string","description":"Country of address represented as country code (ISO 3166-1 alpha-3)","example":"DEU"}},"description":"There are different definitions of Address objects in Receipt structure:\n* **invoiceAddress** - Address of the customer to be billed\n* **deliveryAddress** - Address of the recipient entered by the customer when placing the order. Recipient can be a person or a pickup point.
Only available on receipts of receiptType PURCHASE."},"Benefit__Receipts-V3":{"title":"Benefit","type":"object","properties":{"id":{"type":"string","description":"Discount code applied to the order to get a reduction. Available when reduction is of type PARTNER_DISCOUNT\n"},"description":{"type":"string","description":"Additional info often printed on the pdf for a PriceModification object (on German receipts always in German)If PriceModification object is of type:\n\n* **PARTNER_DISCOUNT**- discount name, provided with sales order event as part of positionGroupPrice-
(What we print on the pdf )- e.g. \"1 € Rabatt\"\n"}},"description":"Additional information about the applied customer benefit.\n"},"Customer__Receipts-V3":{"title":"Customer","required":["invoiceAddress"],"type":"object","properties":{"invoiceAddress":{"$ref":"#/components/schemas/Address__Receipts-V3"}},"description":"Customer details"},"DeliveryCost__Receipts-V3":{"title":"DeliveryCost","required":["deliveryCostType","positionSum","priceModifications","unitPrice"],"type":"object","properties":{"lineNumber":{"type":"integer","description":"Number of line item in which the information is printed on the pdf document of the receipt.\n
This information is not reliably provided for older receipts","format":"int32","example":5},"deliveryCostType":{"type":"string","description":"Type of delivery costs for the shipment of physical goods.
\nPossible values:\n* **DELIVERY_FEE_STANDARD** - basic shipping costs\n* **DELIVERY_FEE_FREIGHT_SURCHARGE** - additional freight surcharge for bulky goods\n","example":"DELIVERY_FEE_STANDARD","enum":["DELIVERY_FEE_STANDARD","DELIVERY_FEE_FREIGHT_SURCHARGE"]},"unitPrice":{"$ref":"#/components/schemas/Price__Receipts-V3"},"positionSum":{"$ref":"#/components/schemas/Price__Receipts-V3"},"priceModifications":{"type":"array","description":"List of additional fees and reductions represented as price modifications.\n
If there are no price modifications, an empty list is displayed","items":{"$ref":"#/components/schemas/PriceModification__Receipts-V3"}}},"description":"List of billed logistic costs, if exists for this receipt.\n
This list is only used in context of receiptType PURCHASE or REFUND.\n
If there are no entries the lists is displayed as empty"},"DeliveryCostPartialRefundPosition__Receipts-V3":{"title":"DeliveryCostPartialRefundPosition","type":"object","description":"This information is currently not available, will be an empty array."},"Details__Receipts-V3":{"title":"Details","required":["description"],"type":"object","properties":{"description":{"type":"string","description":"Additional info often printed on the pdf for a PriceModification object (on German receipts always in German)
\nIf PriceModification object is of type:\n* **PARTNER_DISCOUNT** - discount name, provided with sales order event as part of positionGroupPrice: (What we print on the pdf ): e.g. \"1 € Rabatt\"\n* **DEFECT_COMPENSATION** - ( German translation of defect compensation) \"**Mängelausgleich**\"\n* **REFUND_COMPLAINT_ITEM** - hard coded \"Preisnachlass Reklamation Artikel\"\n","example":"1 € Rabatt"},"id":{"type":"string","description":"Discount code applied to the order to get a reduction. Available when reduction is of type PARTNER_DISCOUNT","example":"82ffff8f-8709-4060-bcd3-ebdabbbc6514"},"linkedReceiptNumber":{"type":"string","description":"Allows to link an earlier purchase or (partial)refund receipt by human-readable identifier.\n
If PriceModification object is of type:\n* **DEFECT_COMPENSATION**: In case of previous (partial) refunds this field contains the human-readable identifier of the partial refund with which the previous refund was made","example":"E-DE-123456789-2020-7"},"linkedReceiptCreationDate":{"type":"string","description":"Allows to show creation date of linked earlier purchase or (partial)refund receipt.\n
If PriceModification object is of type:\n* **DEFECT_COMPENSATION**: In case of previous (partial) refunds this field contains the creation date of linked receipt with which the previous refund was made. (ISO-8601 format)","format":"date-time","example":"2022-06-30T14:35:00.221Z"},"type":{"type":"string","description":"The specific types of discounts provided for Marketplace. This field is only applicable when the priceModificationType for the item is PARTNER_DISCOUNT\n
Possible values:\n* **PARTNER_DISCOUNT** - a Partner Discount provided because of a booked service \"Rabattaktion\" by the partner\n* **PLATFORM_DISCOUNT** - a Discount for a platform frame provided because of a booked service \"Marktplatz Rabattaktion\" by the partner\n","example":"PARTNER_DISCOUNT","enum":["PARTNER_DISCOUNT","PLATFORM_DISCOUNT"]}},"description":"Additional information of increase or decrease of the line item described by this PriceModification object"},"ItemPartialRefundPosition__Receipts-V3":{"title":"ItemPartialRefundPosition","required":["articleNumber","partialRefundAmount","positionItemIds","productTitle"],"type":"object","properties":{"partialRefundDetails":{"$ref":"#/components/schemas/PartialRefundDetails__Receipts-V3"},"lineNumber":{"type":"integer","description":"Number of line item in which the information is printed on the pdf document of the receipt.\n
This information is not reliably provided for older receipts","format":"int32","example":3},"sku":{"type":"string","description":"Stock keeping unit of item. Unique item identifier on partner side","example":"123e4567-e89b-12d3-a456-426652340000"},"articleNumber":{"type":"string","description":"Unique Identifier of item the customer knows from order process","example":"S081B05AP2"},"productTitle":{"type":"string","description":"Product description of item the customer knows from the order process","example":"Bobux »Baby Halbschuhe DIMENSION II für Mädchen« Schnürschuh"},"variationAttributes":{"type":"string","description":"Additional attributes for unique description of item, if different variants of the item are possible. (String of comma seperated dimensions)\n\nATTENTION: In previous version, the information exists as dimensions","example":"Weiß, 19"},"positionItemIds":{"type":"array","description":"List of unique identifiers of specific instances of ordered items.\n
A (salesOrder)PositionItem is the smallest unit of an item that can be ordered","example":["476bb1ac-a227-4710-8ee4-f297a38a309c"],"items":{"type":"string","description":"List of unique identifiers of specific instances of ordered items.\n
A (salesOrder)PositionItem is the smallest unit of an item that can be ordered","example":"[\"476bb1ac-a227-4710-8ee4-f297a38a309c\"]"}},"partialRefundAmount":{"$ref":"#/components/schemas/Price__Receipts-V3"}},"description":"List of billed partial refunds of items.\n
This list is only used in context of receiptType PARTIAL_REFUND.\n
If there are no entries the lists is displayed as empty"},"ItemPosition__Receipts-V3":{"title":"ItemPosition","required":["articleNumber","positionItemIds","positionSum","priceModifications","productTitle","quantity","unitPrice"],"type":"object","properties":{"lineNumber":{"type":"integer","description":"Number of line item in which the information is printed on the pdf document.\n
This information is not reliably provided for older receipts","format":"int32","example":1},"sku":{"type":"string","description":"Stock keeping unit of item. Unique item identifier on partner side.\n
This information is not reliably provided for older receipts","example":"123e4567-e89b-12d3-a456-426652340000"},"expectedPerformancePeriod":{"type":"string","description":"Vague performance date. As the exact date is not known when generating the receipt, this information gives an indication when the item will be shipped","example":"Nach Zahlung wird die Lieferung vorbereitet."},"articleNumber":{"type":"string","description":"Unique Identifier of item the customer knows from order process.\n\nATTENTION: Different from the previous version, the field also contains the promotion. In last version the promotion was provided separately","example":"S081B05AP2"},"productTitle":{"type":"string","description":"Product description of item the customer knows from the order process","example":"Bobux »Baby Halbschuhe DIMENSION II für Mädchen« Schnürschuh"},"variationAttributes":{"type":"string","description":"Additional attributes for unique description of an item, if different variants of the item are possible. (String of comma seperated dimensions)\n\nATTENTION: In previous version the information was called dimensions","example":"Weiß, 19"},"positionItemIds":{"type":"array","description":"List of unique identifiers of specific instances of ordered items.\nA (salesOrder)PositionItem is the smallest unit of an item that can be ordered.\n
If quantity of the specific LineItem object is bigger than one the list contains more than one entry","example":["476bb1ac-a227-4710-8ee4-f297a38a309c","34gfb1ac-4f45-4710-4ef4-t555a38a309g"],"items":{"type":"string","description":"List of unique identifiers of specific instances of ordered items.\nA (salesOrder)PositionItem is the smallest unit of an item that can be ordered.\n
If quantity of the specific LineItem object is bigger than one the list contains more than one entry","example":"[\"476bb1ac-a227-4710-8ee4-f297a38a309c\",\"34gfb1ac-4f45-4710-4ef4-t555a38a309g\"]"}},"quantity":{"type":"integer","description":"Quantity","format":"int32","example":2},"unitPrice":{"$ref":"#/components/schemas/Price__Receipts-V3"},"priceToPayPerPositionItems":{"type":"array","description":"Price of each unit of the item i.e., price of each positionItemId.
It will be available only for PURCHASE receipt","items":{"$ref":"#/components/schemas/PriceToPayPerPositionItem__Receipts-V3"}},"positionSum":{"$ref":"#/components/schemas/Price__Receipts-V3"},"priceModifications":{"type":"array","description":"List of additional fees and reductions represented as price modifications.\n
Currently we only know reductions.\n
If there are no entries the list is displayed as empty","items":{"$ref":"#/components/schemas/PriceModification__Receipts-V3"}}},"description":"List of billed items, if exists.\n
This list is only used in context of receiptType PURCHASE or REFUND.\n
If there are no entries the lists is displayed as empty"},"LineItems__Receipts-V3":{"title":"LineItems","required":["deliveryCosts","deliveryFeePartialRefundPositions","itemPartialRefundPositions","itemPositions","servicePartialRefundPositions","servicePositions"],"type":"object","properties":{"itemPositions":{"type":"array","description":"List of billed items, if exists.\n
This list is only used in context of receiptType PURCHASE or REFUND.\n
If there are no entries the lists is displayed as empty","items":{"$ref":"#/components/schemas/ItemPosition__Receipts-V3"}},"itemPartialRefundPositions":{"type":"array","description":"List of billed partial refunds of items.\n
This list is only used in context of receiptType PARTIAL_REFUND.\n
If there are no entries the lists is displayed as empty","items":{"$ref":"#/components/schemas/ItemPartialRefundPosition__Receipts-V3"}},"servicePositions":{"type":"array","description":"List of billed B2C services, if exists for this receipt.\n
This list is only used in context of receiptType PURCHASE or REFUND.\n
If there are no entries the lists is displayed as empty","items":{"$ref":"#/components/schemas/ServicePosition__Receipts-V3"}},"servicePartialRefundPositions":{"type":"array","description":"This information is currently not available, will be an empty array.","items":{"$ref":"#/components/schemas/ServicePartialRefundPosition__Receipts-V3"}},"deliveryCosts":{"type":"array","description":"List of billed logistic costs, if exists for this receipt.\n
This list is only used in context of receiptType PURCHASE or REFUND.\n
If there are no entries the lists is displayed as empty","items":{"$ref":"#/components/schemas/DeliveryCost__Receipts-V3"}},"deliveryFeePartialRefundPositions":{"type":"array","description":"This information is currently not available, will be an empty array.","items":{"$ref":"#/components/schemas/DeliveryCostPartialRefundPosition__Receipts-V3"}}},"description":"Line items for which settlement is made.\n\nATTENTION: \n* In previous version this name was used for itemPositions only. Now there is a substructure that cares about all billing object of a receipt\n* The object is currently define by mistake as required, we will change it in future as it’s possible that we introduce new receiptTypes without lineItems. For current receiptTypes PURCHASE, PARTIAL_REFUND and REFUND lineItems will always exists."},"LinkedItemDetails__Receipts-V3":{"title":"LinkedItemDetails","required":["articleNumber","productTitle","serviceRelations"],"type":"object","properties":{"itemReceiptNumber":{"type":"string","description":"Human-readable identifier refers to the receipt the linked item was billed.
\nDisplayed only if item is billed with another receipt.
\nIn case of receiptType\n* **PURCHASE** - **receiptNumber of purchase receipt**.
\nIf this field is not present, you will find information in receipt.receiptNumber\n* **REFUND** - **receiptNumber of purchase receipt**.
\nIf this field is not present ,you will find information in receipt.linkedReceiptNumber\n","example":"R-DE-123456789-2020-715"},"itemPartnerName":{"type":"string","description":"Name of the partner who sold the linked item.\n
Displayed only if the partner is different from partner of the receipt","example":"Tonio Mertez e.K."},"sku":{"type":"string","description":"Stock keeping unit of the linked item. Unique item identifier on partner side\n
This information is not reliably provided for older receipts.\n","example":"123e4567-e89b-12d3-a456-426652340000"},"articleNumber":{"type":"string","description":"Unique Identifier of linked item the customer knows from order process.\n\nATTENTION: Different from the previous version, the field also contains the promotion. In last version the promotion was provided separately","example":"S081B05AP2"},"productTitle":{"type":"string","description":"Product description of linked item the customer knows from the order process","example":"Bobux »Baby Halbschuhe DIMENSION II für Mädchen« Schnürschuh"},"serviceRelations":{"type":"array","description":"List of ServiceRelation objects.\n
Contains entries if services were sold together with items otherwise list is empty","items":{"$ref":"#/components/schemas/ServiceRelation__Receipts-V3"}}},"description":"Additional information to an item directly related to the service.\n
Object exists only if the service was sold together with an item"},"PartialRefundDetails__Receipts-V3":{"title":"PartialRefundDetails","type":"object","properties":{"benefit":{"$ref":"#/components/schemas/Benefit__Receipts-V3"}},"description":"Additional information about the granted partial refund to this item.\n"},"Partner__Receipts-V3":{"title":"Partner","required":["city","countryCode","partnerName","representedBy","street","vatId","zipCode"],"type":"object","properties":{"partnerName":{"type":"string","description":"Name of the selling partner/company.\n\nATTENTION: In previous version the information was called name","example":"Funky Staff GmbH & Co. KG"},"street":{"type":"string","description":"Street and house number of company address","example":"Berner Straße 109"},"zipCode":{"type":"string","description":"Zip code of company address","example":"60437"},"city":{"type":"string","description":"City of company address","example":"Hamburg"},"countryCode":{"type":"string","description":"Country of company address represented as country code (ISO 3166-1 alpha-3)","example":"DEU"},"vatId":{"type":"string","description":"Value added tax identification number of partner","example":"DE215947224"},"representedBy":{"type":"string","description":"The partner's representative(s).\n\nATTENTION: In previous version the information was called legalRepresentatives","example":"Monika Sievers, Paul Ackermann"},"registerCourt":{"type":"string","description":"Court where the company is registered.
Information exists if it's maintained in partner core data.\n\nATTENTION: In previous version the information was called districtCourt","example":"Amtsgericht Hamburg"},"commercialRegisterNumber":{"type":"string","description":"Commercial register number. Unique in context of register court.
Information exists if it's maintained in partner core data.\n\nATTENTION: In previous version the information was called registerNumber","example":"HRB 5433221"},"headOfSupervisoryBoard":{"type":"string","description":"The partner's head of supervisory board.
Information exists if it's maintained in partner core data","example":"Hugo Steiner"},"shopName":{"type":"string","description":"Alias name of partner.
Information exists if it's maintained in partner core data","example":"Fun-Shop"},"weeeRegistrationNumber":{"type":"string","description":"WEEE registration number of partner.
Information exists if it's maintained in partner core data"}},"description":"Partner for whom the receipt is created"},"Payment__Receipts-V3":{"title":"Payment","required":["paymentMethod","paymentProvider"],"type":"object","properties":{"paymentProvider":{"type":"string","description":"Payment Provider chosen for the order.
\nPossible values:\n* **PLAZA** - Ratepay\n* **OTTOPAYMENT** - OTTO Payments\n","example":"OTTOPAYMENTS","enum":["PLAZA","OTTOPAYMENTS"]},"paymentMethod":{"type":"string","description":"Payment method chosen by the customer to pay for this order","example":"CREDIT_CARD_ONLINE","enum":["CREDIT_CARD_ONLINE","INVOICE_SINGLE","INVOICE_INSTALLMENTS","DIRECT_DEBIT_INSTALLMENTS","PREPAYMENT","DIRECT_DEBIT","PAYPAL"]},"installmentCount":{"type":"integer","description":"For payment methods with installments, this attribute indicates how many installments the customer has chosen when placing the order.\n
Only available on receipts of receiptType PURCHASE.\n
This information is not reliably provided for older receipts","format":"int32","example":3}},"description":"Payment details"},"Price__Receipts-V3":{"title":"Price","required":["gross","taxRate","taxType"],"type":"object","properties":{"taxType":{"type":"string","description":"The fields indicates what kind of tax the price object includes.
\nCurrently prices of the following taxTypes are possible\n* **VAT** - vat rate\n","example":"VAT","enum":["VAT"]},"taxRate":{"type":"string","description":"Applied tax rate, if there is any.
\nCurrently the entry can only be a decimal numbers.
\nIn future it's maybe also possible to have an expression such as \"NON_TAXABLE\", so we decided for a representation as string\n
_In live we currently only can deal assortments of German regular VAT rate_\n","example":"19.0"},"gross":{"description":"Calculated gross value","allOf":[{"title":"MonetaryAmount","required":["amount","currency"],"type":"object","properties":{"amount":{"type":"number","description":"Value of the monetary amount expressed in currency.
\nThe number format expects a decimal point, like 10.99. Numbers without a decimal point are taken as a unit of the given currency,\nE.g. 10.05 EUR = 10 Euro and 5 Cent\n","example":209.82},"currency":{"type":"string","description":"Currency of monetary amount (ISO-4217)","example":"EUR"}}}]},"net":{"description":"Calculated net value
\nThis information is not reliably provided for older receipts.This information is not reliably provided for older receipts for all Price objects.. In the beginning we only provides this value for receipt.totals. \n
In receipts generated after the 01-01-2023 data should always be set in all Price objects.\n","allOf":[{"title":"MonetaryAmount","required":["amount","currency"],"type":"object","properties":{"amount":{"type":"number","description":"Value of the monetary amount expressed in currency.
\nThe number format expects a decimal point, like 10.99. Numbers without a decimal point are taken as a unit of the given currency,\nE.g. 10.05 EUR = 10 Euro and 5 Cent\n","example":174.85},"currency":{"type":"string","description":"Currency of monetary amount (ISO-4217)","example":"EUR"}}}]},"tax":{"description":" Calculated tax value
\n This information is not reliably provided for older receipts.This information is not reliably provided for older receipts for all Price objects.. In the beginning we only provides this value for receipt.totals. \n
In receipts generated after the 01-01-2023 data should always be set in all Price objects.\n","allOf":[{"title":"MonetaryAmount","required":["amount","currency"],"type":"object","properties":{"amount":{"type":"number","description":"Value of the monetary amount expressed in currency.
\nThe number format expects a decimal point, like 10.99. Numbers without a decimal point are taken as a unit of the given currency,\nE.g. 10.05 EUR = 10 Euro and 5 Cent\n","example":34.97},"currency":{"type":"string","description":"Currency of monetary amount (ISO-4217)","example":"EUR"}}}]}},"description":"Costs of an object\nThere are different definitions of Price objects in Receipt structure:\n * **unitPrice** - Original price for quantity a line item object\n * **positionSum** - Price for quantity x unitPrice of a line item object minus reductions of all sub priceModification objects, if exist\n * **partialRefundAmount** - Granted reduction by the partner on item\n * **priceModificationAmount** - Total reduction for the super ordinated line item object. If the line item object has a quantity, this is already been taken into account in this amount.\n * **priceToPay** - Price for quantity one minus all instant reductions like partner discount ... when selling (excl. earlier partial refunds).
Only available on receipts of receiptType PURCHASE.\n"},"PriceModification__Receipts-V3":{"title":"PriceModification","required":["details","priceModificationAmount","priceModificationType"],"type":"object","properties":{"lineNumber":{"type":"integer","description":"Number of line item in which the information is printed on the pdf document of the receipt.\n
On the pdf documents increases and decreases do not necessarily have to be shown on the same line. If there is a discrepancy, it is visible by different line numbers of this object and the parent line item object\n
This information is not reliably provided for older receipts","format":"int32","example":1},"priceModificationType":{"type":"string","description":"This type describes the special increases or decreases in detail and how to deal with it.\n\nThe following priceModificationTypes are possible:\n\n* **PARTNER_DISCOUNT** - Partner-financed immediate discount granted to the customer at the time of purchase. Reduction of parent object item position applicable on receipts of type PURCHASE and REFUND\n* **DEFECT_COMPENSATION / REFUND_COMPLAINT_ITEM** - Partial refund already refunded by a partial refund receipt to compensate a defect.\nReduction of parent object item position on receipts of type REFUND\n","example":"PARTNER_DISCOUNT","enum":["PARTNER_DISCOUNT","DEFECT_COMPENSATION","REFUND_COMPLAINT_ITEM"]},"details":{"$ref":"#/components/schemas/Details__Receipts-V3"},"priceModificationAmount":{"$ref":"#/components/schemas/Price__Receipts-V3"}},"description":"List of additional fees and reductions represented as price modifications.\n
If there are no price modifications, an empty list is displayed"},"PriceToPayPerPositionItem__Receipts-V3":{"title":"PriceToPayPerPositionItem","required":["positionItemIds","priceToPay"],"type":"object","properties":{"positionItemIds":{"type":"array","description":"List of unique identifiers of specific instances of ordered items.\n
A (salesOrder)PositionItem is the smallest unit of an item that can be ordered.\n","example":["476bb1ac-a227-4710-8ee4-f297a38a309c","34gfb1ac-4f45-4710-4ef4-t555a38a309g"],"items":{"type":"string","description":"List of unique identifiers of specific instances of ordered items.\n
A (salesOrder)PositionItem is the smallest unit of an item that can be ordered.\n","example":"[\"476bb1ac-a227-4710-8ee4-f297a38a309c\",\"34gfb1ac-4f45-4710-4ef4-t555a38a309g\"]"}},"priceToPay":{"$ref":"#/components/schemas/Price__Receipts-V3"}},"description":"Price of each unit of the item i.e., price of each positionItemId.
It will be available only for PURCHASE receipt"},"Receipt__Receipts-V3":{"title":"Receipt","required":["amountDue","creationDate","customer","isRealReceipt","lineItems","orderDate","orderNumber","partner","payment","receiptNumber","receiptType","salesOrderId","totals"],"type":"object","properties":{"receiptType":{"type":"string","description":"Categorisation that classifies the receipts according to the main characteristics\n\nATTENTION: In previous version the information was called type\n","example":"REFUND","enum":["PURCHASE","REFUND","PARTIAL_REFUND"]},"isRealReceipt":{"type":"boolean","description":" Counterpart to the sentence \"Dies ist kein Beleg/keine Rechnung im Sinne des Umsatzsteuergesetzes und berechtigt nicht zum Vorsteuerabzug.\" on pdf document.\n * Set to **true** since real customer invoices/refunds for shipments to locations in domestic tax territory are created.\n * Set to **false** for technical receipts not visible to customer or on receipts with delivery addresses on Helgoland or in Büsingen\n","example":true},"receiptNumber":{"type":"string","description":"Human readable identifier of a receipt known by customer.
Guaranteed to be unique per partner","example":"E-DE-123456789-2020-7"},"creationDate":{"type":"string","description":"Date when receipt is created by system (UTC in ISO-8601 format)","format":"date-time"},"salesOrderId":{"type":"string","description":"Technical identifier of corresponding sales order","example":"80ec6483-4d53-44d8-9ba7-e846ab24da38"},"orderNumber":{"type":"string","description":"Order number of corresponding sales order","example":"1224567"},"orderDate":{"type":"string","description":"Order date of corresponding sales order (UTC in ISO-8601 format)","format":"date-time"},"shipmentDate":{"type":"string","description":"Date when physical items of this receipt were handed over to the carrier to be delivered to the customer (UTC in ISO-8601 format).
Only available on receipts of receiptType PURCHASE.","format":"date-time"},"linkedReceiptNumber":{"type":"string","description":"Human-readable identifier of linked receipt.
In case of receiptType PARTIAL_REFUND or REFUND it is the receiptINumber of purchase receipt.\n\nATTENTION: In previous version the information was called originalReceiptNumber","example":"R-DE-123456789-2020-1507"},"linkedCreationDate":{"type":"string","description":"Creation date of linked receipt (UTC in ISO-8601 format).
Only available if there is a linked receipt.\n\nATTENTION: In previous version the information was called originalCreatedDate","format":"date-time"},"payment":{"$ref":"#/components/schemas/Payment__Receipts-V3"},"partner":{"$ref":"#/components/schemas/Partner__Receipts-V3"},"customer":{"$ref":"#/components/schemas/Customer__Receipts-V3"},"deliveryAddress":{"$ref":"#/components/schemas/Address__Receipts-V3"},"lineItems":{"$ref":"#/components/schemas/LineItems__Receipts-V3"},"totals":{"type":"array","description":"Total amounts of receipt per tax type and tax rate","items":{"$ref":"#/components/schemas/Price__Receipts-V3"}},"refundType":{"type":"string","description":"Describes the business case of a refund. Has an impact on the business flow and the PDF texts.\n
Only available on receipts of receiptType REFUND and not reliable provided on older partial refunds receipts.\n\nThe following refundTypes are possible:\n* **RETURN** - Refund due to a return\n* **CANCELLATION** - Refund of delivery fees due to a cancellation\n","example":"RETURN","enum":["RETURN","CANCELLATION"]},"partialRefundType":{"type":"string","description":"Business case of partial refund chosen by partner. Has an impact on the business flow and the PDF.\n
Only available on receipts of receiptType PARTIAL_REFUND and not reliable provides on older partial refunds receipts.\n\nPossible values: \n* **REFUND_COMPLAINT_ITEM** - Refund because of justified customer complaint on item. Will replace first partial refund business case DEFECT_COMPENSATION, that was introduced without having a partialRefundType at all.","example":"REFUND_COMPLAINT_ITEM","enum":["REFUND_COMPLAINT_ITEM"]},"amountDue":{"description":"The amountDue documents the gross amount a customer still has to pay or will be refunded respectively owes less (the latter decision depends on the chosen payment method) with this receipt.\n
As in case of receiptType PURCHASE and a prepaid payment method we know for sure that the customer has already paid in advance, so the amount is 0 € otherwise the content is identically with totalsGrossAmount","allOf":[{"title":"MonetaryAmount","required":["amount","currency"],"type":"object","properties":{"amount":{"type":"number","description":"Value of the monetary amount expressed in currency.
\nThe number format expects a decimal point, like 10.99. Numbers without a decimal point are taken as a unit of the given currency,\nE.g. 10.05 EUR = 10 Euro and 5 Cent\n","example":209.82},"currency":{"type":"string","description":"Currency of monetary amount (ISO-4217)","example":"EUR"}}}]},"totalsGrossAmount":{"description":"Gross amounts of totals summed up over all prices. Only available on receipts of receiptType PURCHASE","allOf":[{"title":"MonetaryAmount","required":["amount","currency"],"type":"object","properties":{"amount":{"type":"number","description":"Value of the monetary amount expressed in currency.
\nThe number format expects a decimal point, like 10.99. Numbers without a decimal point are taken as a unit of the given currency,\nE.g. 10.05 EUR = 10 Euro and 5 Cent\n","example":209.82},"currency":{"type":"string","description":"Currency of monetary amount (ISO-4217)","example":"EUR"}}}]},"totalsReductions":{"type":"array","description":"Reduction amounts on total value of receipts","items":{"$ref":"#/components/schemas/TotalsReduction__Receipts-V3"}}},"description":"Collection of all details of a receipt"},"ServicePartialRefundPosition__Receipts-V3":{"title":"ServicePartialRefundPosition","type":"object","description":"This information is currently not available, will be an empty array."},"ServicePosition__Receipts-V3":{"title":"ServicePosition","required":["positionSum","priceModifications","quantity","serviceName","servicePositionItemIds","unitPrice"],"type":"object","properties":{"lineNumber":{"type":"integer","description":"Number of line item in which the information is printed on the pdf document of the receipt.\n
This information is not reliably provided for older receipts","format":"int32","example":3},"serviceType":{"type":"string","description":"Categorization that classifies services according to their main characteristics. Services of the same type are often treated in the same way.\nCurrently, the processing of the following types are possible:\n* **DISPOSAL** - Free take away of old technical devices required by law\n","example":"DISPOSAL","enum":["DISPOSAL"]},"expectedPerformancePeriod":{"type":"string","description":"Vague performance date.
As the exact date is not known when generating the receipt, this information gives an indication when the service is expected to be fulfilled"},"serviceName":{"type":"string","description":"Service name the customer knows from the order process","example":"48 Monate Langzeitgarantie Personal Care"},"servicePositionItemIds":{"type":"array","description":"List of unique identifiers of specific instances of services.\n
A servicePositionItem is the smallest unit of a service that can be ordered.\n
If quantity of this object is bigger than one, the list contains more than one entry","example":["476bb1ac-a2277-4710-8ee4-f297a38a309c","476bb1ac-a227-4710-8ee4-f297a38a309b"],"items":{"type":"string","description":"List of unique identifiers of specific instances of services.\n
A servicePositionItem is the smallest unit of a service that can be ordered.\n
If quantity of this object is bigger than one, the list contains more than one entry","example":"[\"476bb1ac-a2277-4710-8ee4-f297a38a309c\",\"476bb1ac-a227-4710-8ee4-f297a38a309b\"]"}},"linkedItemDetails":{"$ref":"#/components/schemas/LinkedItemDetails__Receipts-V3"},"quantity":{"type":"integer","description":"Quantity","format":"int32","example":2},"unitPrice":{"$ref":"#/components/schemas/Price__Receipts-V3"},"positionSum":{"$ref":"#/components/schemas/Price__Receipts-V3"},"priceModifications":{"type":"array","description":"List of additional fees and reductions represented as price modifications.\n
Currently we only know reductions.\n
If there are no entries the list is displayed as empty","items":{"$ref":"#/components/schemas/PriceModification__Receipts-V3"}}},"description":"List of billed B2C services and insurances."},"ServiceRelation__Receipts-V3":{"title":"ServiceRelation","required":["positionItemId","servicePositionItemId"],"type":"object","properties":{"servicePositionItemId":{"type":"string","description":"Unique identifier of a specific instance of a service. ServicePositionItem is the smallest unit of service that can be ordered","example":"476bb1ac-a2277-4710-8ee4-f297a38a309c"},"positionItemId":{"type":"string","description":"Unique identifier of a specific instance of an ordered item (salesOrder)PositionItem is the smallest unit of an item that can be ordered","example":"476bb1ac-a2277-4710-8ee4-f297a38a309b"}},"description":"A ServiceRelation object describes the relationship between a specific instance of a servicePositionItem object and a specific instance of a (salesOrder)PositionItem object"},"TotalsReduction__Receipts-V3":{"title":"TotalsReduction","type":"object","description":"Reduction amounts on total value of receipts"},"Link__Receipts-V3":{"title":"Link","type":"object","properties":{"href":{"type":"string","description":"The url of the link","example":"/v3/receipts?limit=128&page=2"},"rel":{"type":"string","description":"The relation type of the link. See also https://www.iana.org/assignments/link-relations/link-relations.xhtml. The relation type 'next' is used for paging. The relation type 'self' refers to the url of the resource","example":"next,self,describedby"}},"description":"A link to various resources. a Link can have different meanings and targets. The type of relation is specified with the property 'rel'. "},"ReceiptsList__Receipts-V3":{"title":"ReceiptsList","type":"object","properties":{"resources":{"type":"array","description":"The list of queried resources. In this case partner receipts.","items":{"$ref":"#/components/schemas/Receipt__Receipts-V3"}},"links":{"type":"array","description":"Links related to the list. E.g. the link to the successive list used during paging.","items":{"$ref":"#/components/schemas/Link__Receipts-V3"}}}},"PriceReductionResponse__Price-Reductions-V1":{"title":"PriceReductionResponse","type":"object","properties":{"salesOrderId":{"type":"string","description":"salesOrderId for an item","format":"uuid"},"totalPriceReduction":{"description":"sum of all the price reductions for a positionItemId.","allOf":[{"title":"MonetaryAmount","type":"object","properties":{"amount":{"type":"number","description":"Holds the value of the monetary amount expressed in a currency, e.g. euros. The number format expects a decimal point, like 10.99. Numbers without a decimal point are taken as a unit of the given currency, e.g. 10 is taken as 10 euros","example":121.01},"currency":{"type":"string","description":"Holds the currency of the monetary amount expressed as a shortcut according to ISO 4217 and http://publications.europa.eu/code/de/de-5000700.htm. Currently Only EUR is supported as a currency","example":"EUR"}}}]},"invoicePrice":{"description":"the price of the positionItemId as per the invoice generated for the order.","allOf":[{"title":"MonetaryAmount","type":"object","properties":{"amount":{"type":"number","description":"Holds the value of the monetary amount expressed in a currency, e.g. euros. The number format expects a decimal point, like 10.99. Numbers without a decimal point are taken as a unit of the given currency, e.g. 10 is taken as 10 euros","example":121.01},"currency":{"type":"string","description":"Holds the currency of the monetary amount expressed as a shortcut according to ISO 4217 and http://publications.europa.eu/code/de/de-5000700.htm. Currently Only EUR is supported as a currency","example":"EUR"}}}]},"priceReductions":{"type":"array","description":"all price reductions applied for an item","items":{"$ref":"#/components/schemas/PriceReductionDetail__Price-Reductions-V1"}},"positionItemId":{"type":"string","description":"positionItemId for an item","format":"uuid"}}},"APIErrorResponse__Price-Reductions-V1":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/APIResponse__Price-Reductions-V1"}}}},"APIResponse__Price-Reductions-V1":{"type":"object","properties":{"path":{"type":"string"},"title":{"type":"string"},"code":{"type":"integer","format":"int32"},"detail":{"type":"string"},"logref":{"type":"string"}}},"PriceReductionDetail__Price-Reductions-V1":{"type":"object","properties":{"receiptNumber":{"type":"string","description":"receiptNumber of the receipt generated for the price reduction. The receiptNumber would be null is the status of the price reduction is Initiated"},"priceReduction":{"description":"the price reduction amount for a positionItemId.","allOf":[{"title":"MonetaryAmount","type":"object","properties":{"amount":{"type":"number","description":"Holds the value of the monetary amount expressed in a currency, e.g. euros. The number format expects a decimal point, like 10.99. Numbers without a decimal point are taken as a unit of the given currency, e.g. 10 is taken as 10 euros","example":121.01},"currency":{"type":"string","description":"Holds the currency of the monetary amount expressed as a shortcut according to ISO 4217 and http://publications.europa.eu/code/de/de-5000700.htm. Currently Only EUR is supported as a currency","example":"EUR"}}}]},"creationDateTime":{"type":"string"},"status":{"description":"Status of the price reduction.\n- INITIATED: This status implies that the reduction are pending for receipt generation, and receiptId and receiptNumber would be null for INITIATED reductions.\n- PROCESSED: This status implies that the reductions for which receipts are generated.\n- REJECTED: This status implies that the reductions which failed validations and were not processed. eg. reductions applied on the positionItemId after it is marked as returned.\n","enum":["PROCESSED","INITIATED","REJECTED"]}},"description":"all price reductions applied for an item"},"Link__Price-Reductions-V1":{"title":"Link","type":"object","properties":{"href":{"type":"string","description":"The url of the link","example":"/v1/price-reductions?limit=1&page=2"},"rel":{"type":"string","description":"The relation type of the link. See also https://www.iana.org/assignments/link-relations/link-relations.xhtml. The relation type 'next' is used for paging","example":"next"}},"description":"A link to various resources. a Link can have different meanings and targets. The type of relation is specified with the property 'rel'. "},"PriceReductionsResponse__Price-Reductions-V1":{"title":"PriceReductionsResponse","type":"object","properties":{"results":{"type":"array","description":"The list of queried resources. In this case partner reductions.","items":{"$ref":"#/components/schemas/PriceReductionResponse__Price-Reductions-V1"}},"links":{"type":"array","description":"Links related to the list. E.g. the link to the successive list used during paging.","items":{"$ref":"#/components/schemas/Link__Price-Reductions-V1"}}}},"PartnerPriceReductionRequest__Price-Reductions-V1":{"required":["positionItemId","priceReduction","salesOrderId"],"type":"object","properties":{"positionItemId":{"type":"string","format":"uuid"},"salesOrderId":{"type":"string","format":"uuid"},"priceReduction":{"description":"The price reduction amount to be applied on the positionItemId.","allOf":[{"title":"MonetaryAmount","type":"object","properties":{"amount":{"type":"number","description":"Holds the value of the monetary amount expressed in a currency, e.g. euros. The number format expects a decimal point, like 10.99. Numbers without a decimal point are taken as a unit of the given currency, e.g. 10 is taken as 10 euros","example":121.01},"currency":{"type":"string","description":"Holds the currency of the monetary amount expressed as a shortcut according to ISO 4217 and http://publications.europa.eu/code/de/de-5000700.htm. Currently Only EUR is supported as a currency","example":"EUR"}}}]}}},"ForbiddenApplyPriceReduction__Price-Reductions-V1":{"description":"The partner does not have the required permissions.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/APIErrorResponse__Price-Reductions-V1"}},"example":{"errors":[{"title":"Forbidden","code":403,"detail":"Access is denied, please make sure you have right permissions.","path":"/v1/price-reductions/{salesOrderId}/{positionItemId}"}]}},"ForbiddenGetPriceReduction__Price-Reductions-V1":{"description":"The partner does not have the required permissions.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/APIErrorResponse__Price-Reductions-V1"}},"example":{"errors":[{"title":"Forbidden","code":403,"detail":"Access is denied, please make sure you have right permissions","path":"/v1/price-reductions/"}]}},"NotFoundPriceReductionForPositionItemId__Price-Reductions-V1":{"description":"Price reduction for a positionItemId does not exist.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/APIErrorResponse__Price-Reductions-V1"}},"example":{"errors":[{"title":"Not Found","code":404,"detail":"No PriceReduction applied for item with positionItemId","path":"/v1/price-reductions/{salesOrderId}/{positionItemId}"}]}},"NotFoundPositionItemId__Price-Reductions-V1":{"description":"PositionItemId does not exist","type":"object","properties":{"errors":{"$ref":"#/components/schemas/APIErrorResponse__Price-Reductions-V1"}},"example":{"errors":[{"title":"Not Found","code":404,"detail":"PositionItemId does not exist","path":"/v1/price-reductions/{salesOrderId}/{positionItemId}"}]}},"ConflictPositionItemId__Price-Reductions-V1":{"description":"PositionItemId is not shipped or returned.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/APIErrorResponse__Price-Reductions-V1"}},"example":{"errors":[{"title":"Conflict","code":409,"detail":"Price reduction cannot be applied as sales order position item is not yet shipped or has been returned.","path":"/v1/price-reductions/{salesOrderId}/{positionItemId}"}]}},"AcceptedPriceReductionResponse__Price-Reductions-V1":{"description":"Price reduction has been initiated successfully. Please wait for sometime.","type":"object","properties":{"results":{"$ref":"#/components/schemas/APIResponse__Price-Reductions-V1"}},"example":{"results":[{"title":"Accepted","code":202,"detail":"Price reduction has been initiated successfully. Please wait for sometime.","path":"/v1/price-reductions/{salesOrderId}/{positionItemId}"}]}},"InternalServerErrorApplyPriceReduction__Price-Reductions-V1":{"description":"An unexpected error has occurred while applying price reduction. Please try again.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/APIErrorResponse__Price-Reductions-V1"}},"example":{"errors":[{"title":"Internal Server Error","code":500,"detail":"An unexpected error has occurred. Please try again.","path":"/v1/price-reductions"}]}},"FailedDependency__Price-Reductions-V1":{"description":"Price reduction cannot be applied due to internal error.","type":"object","properties":{"errors":{"$ref":"#/components/schemas/APIErrorResponse__Price-Reductions-V1"}},"example":{"errors":[{"title":"Failed Dependency","code":424,"detail":"Price reduction cannot be applied due to internal error.","path":"/v1/price-reductions"}]}}},"examples":{"ShipmentCreateRequestParcelDelivery__Shipments-V1":{"value":{"trackingKey":{"carrier":"HERMES","trackingNumber":"H1234567890123456789"},"shipDate":"2019-10-11T07:49:12.642Z","shipFromAddress":{"city":"Dresden","countryCode":"DEU","zipCode":"01067"},"positionItems":[{"positionItemId":"b01b8ad2-a49c-47fc-8ade-8629ec000020","salesOrderId":"bf43d748-f13d-49ca-b2e2-1824e9000021","returnTrackingKey":{"carrier":"DHL","trackingNumber":"577546565072"}},{"positionItemId":"b01b8ad2-a49c-47fc-8ade-8629ec000022","salesOrderId":"bf43d748-f13d-49ca-b2e2-1824e9000021","returnTrackingKey":{"carrier":"DHL","trackingNumber":"577546565072"}}]}},"MultiparcelShipmentCreateRequestParcelDelivery__Shipments-V1":{"value":[{"trackingKey":{"carrier":"HERMES","trackingNumber":"H1234567890123456788"},"shipDate":"2019-10-11T07:49:12.642Z","shipFromAddress":{"city":"Dresden","countryCode":"DEU","zipCode":"01067"},"positionItems":[{"positionItemId":"b01b8ad2-a49c-47fc-8ade-8629ec000020","salesOrderId":"bf43d748-f13d-49ca-b2e2-1824e9000021","returnTrackingKey":{"carrier":"DHL","trackingNumber":"577546565072"}}]},{"trackingKey":{"carrier":"HERMES","trackingNumber":"H1234567890123456789"},"shipDate":"2019-10-11T07:49:12.643Z","shipFromAddress":{"city":"Dresden","countryCode":"DEU","zipCode":"01067"},"positionItems":[{"positionItemId":"b01b8ad2-a49c-47fc-8ade-8629ec000020","salesOrderId":"bf43d748-f13d-49ca-b2e2-1824e9000021","returnTrackingKey":{"carrier":"DHL","trackingNumber":"577546565073"}}]}]},"ShipmentCreateRequestForwarderDelivery__Shipments-V1":{"value":{"trackingKey":{"carrier":"OTHER_FORWARDER","trackingNumber":"FF12345678"},"shipDate":"2019-10-11T07:49:12.642Z","shipFromAddress":{"city":"Dresden","countryCode":"DEU","zipCode":"01067"},"positionItems":[{"positionItemId":"b01b8ad2-a49c-47fc-8ade-8629ec000020","salesOrderId":"bf43d748-f13d-49ca-b2e2-1824e9000021"},{"positionItemId":"b01b8ad2-a49c-47fc-8ade-8629ec000022","salesOrderId":"bf43d748-f13d-49ca-b2e2-1824e9000021"}]}},"ShipmentCreateRequestForwarderDeliveryWithoutTrackingNo__Shipments-V1":{"value":{"trackingKey":{"carrier":"OTHER_FORWARDER"},"shipDate":"2019-10-11T07:49:12.642Z","shipFromAddress":{"city":"Dresden","countryCode":"DEU","zipCode":"01067"},"positionItems":[{"positionItemId":"b01b8ad2-a49c-47fc-8ade-8629ec000020","salesOrderId":"bf43d748-f13d-49ca-b2e2-1824e9000021"},{"positionItemId":"b01b8ad2-a49c-47fc-8ade-8629ec000022","salesOrderId":"bf43d748-f13d-49ca-b2e2-1824e9000021"}]}},"ShipmentCreateInsufficientPermissionsResponse__Shipments-V1":{"description":"A position item in the request doesn't belong to the partner.","value":{"errors":[{"title":"INSUFFICIENT_PERMISSION","detail":"The partner is not allowed to create/update a shipment for position item ID","path":"/shipments","jsonPath":"positionItems[0].positionItemId"}]}},"MultiparcelShipmentCreateInsufficientPermissionsResponse__Shipments-V1":{"description":"A position item in the request doesn't belong to the partner.","value":{"errors":[{"title":"INSUFFICIENT_PERMISSION","detail":"The partner is not allowed to create/update a shipment for position item ID","path":"/multiparcel-shipments/shipments","jsonPath":"shipments[0].positionItems[0].positionItemId"}]}},"ShipmentCreateTrackingKeyMandatoryResponse__Shipments-V1":{"description":"The tracking key in the request is mandatory.","value":{"errors":[{"title":"PROPERTY_IS_MANDATORY","detail":"The property is mandatory","path":"/shipments","jsonPath":"trackingKey"}]}},"MultiparcelShipmentCreateTrackingKeyMandatoryResponse__Shipments-V1":{"description":"The tracking key in the request for a shipment is mandatory.","value":{"errors":[{"title":"PROPERTY_IS_MANDATORY","detail":"The property is mandatory","path":"/multiparcel-shipments/shipments","jsonPath":"shipments[0].trackingKey"}]}},"ShipmentAddPositionItemsInsufficientPermissionsResponse__Shipments-V1":{"description":"A position item in the request doesn't belong to the partner.","value":{"errors":[{"title":"INSUFFICIENT_PERMISSION","detail":"The partner is not allowed to create/update a shipment for position item ID","path":"/shipments","jsonPath":"[0].positionItemId"}]}}},"headers":{"ETag":{"description":"The RFC 7232 ETag header field in a response provides the entity-tag of a selected resource. The entity-tag is an opaque identifier for versions and representations of the same resource over time, regardless whether multiple versions are valid at the same time. An entity-tag consists of an opaque quoted string, possibly prefixed by a weakness indicator (see [RFC 7232 Section 2.3](https://tools.ietf.org/html/rfc7232#section-2.3).","example":"7da7a728f910","explode":false,"required":false,"schema":{"type":"string"},"style":"simple"},"Last-Modified":{"description":"TThe Last-Modified header field in a response provides a timestamp indicating the date and time at which the origin server believes the selected representation was last modified, as determined at the conclusion of handling the request (see [RFC 7232 Section 2.3](https://tools.ietf.org/html/rfc7232#section-2.2).","example":"Tue, 15 Nov 1994 12:45:26 GMT","explode":false,"required":false,"schema":{"type":"string"},"style":"simple"}},"parameters":{"If-Match":{"description":"The RFC7232 If-Match header field in a request requires the server to only operate on the resource that matches at least one of the provided entity-tags. This allows clients express a precondition that prevent the method from being applied if there have been any changes to the resource (see [RFC 7232 Section 3.1](https://tools.ietf.org/html/rfc7232#section-3.1).","example":"7da7a728f910","explode":false,"in":"header","name":"If-Match","required":false,"schema":{"type":"string"},"style":"simple"},"If-None-Match":{"description":"The RFC7232 If-None-Match header field in a request requires the server to only operate on the resource if it does not match any of the provided entity-tags. If the provided entity-tag is `*`, it is required that the resource does not exist at all (see [RFC 7232 Section 3.2](https://tools.ietf.org/html/rfc7232#section-3.2)","example":"7da7a728f910","explode":false,"in":"header","name":"If-None-Match","required":false,"schema":{"type":"string"},"style":"simple"},"If-Modified-Since":{"description":"The RFC7232 If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.","example":"Sat, 29 Oct 1994 19:43:31 GMT","explode":false,"in":"header","name":"If-Modified-Since","required":false,"schema":{"type":"string"},"style":"simple"},"If-Unmodified-Since":{"description":"The RFC7232 If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.","example":"Sat, 29 Oct 1994 19:43:31 GMT","explode":false,"in":"header","name":"If-Unmodified-Since","required":false,"schema":{"type":"string"},"style":"simple"}},"requestBodies":{},"responses":{}},"tags":[{"name":"Products-V3","description":"### Product interfaces\nThe product interfaces allow partners to manage their product data in the OTTO Market, which means to send products for publishing on OTTO.de, to view the sent data, and to manage the visibility of the products on otto.de.\n\nThe API offers endpoints for different aspects of product data management:\n\n- The \"Products\" endpoint can be used to send the products to the OTTO Market. The POST operation will return a state \"PENDING\" and a process id which identifies the processing of the request. This process id is delivered in the response body of the POST request as a collection of links (like \"update-tasks/8a9ab7ec-b1ba-4917-bffa-e1d22f2ebe1b\". These links can be used in a GET operation to look at the results of the processing of the sent product data. You as a partner might send many variations in one request, so the processing could take some time, therefore we only offer an asynchronous access to the received product data. The GET operation of the \"Products\" endpoint can be used after the end of the processing to watch the representation of the product in the exact state sent by you. The state changes to \"DONE\", when the operation is finished and you get an executive summary of the operation. This summary shows the total amount of variations in the process and breaks it down to the amount of variations, which were processed successfully, failed or were send unchanged.\n\n- The \"Product Active Status\" endpoint allows you to pull the products from otto.de, or to put them back to visibility on otto.de. For this you have the POST operation. There is also a GET operation to view the state of products.\n\n- Use the \"Marketplace Status\" endpoint to query the status of the product variations on the OTTO marketplace. If a product variation has been processed without errors, the status includes the link to the product variation on otto.de.\n\n- The \"Brands\" endpoint gives you all the brands OTTO Market knows and can reference. You should use this endpoint to make the brand in your products fit to OTTO Market brand IDs.\n\n- The \"Categories\" endpoint gives you all the assortment categories OTTO Market has defined, so you should use this endpoint to make the category names in your products fit to OTTO Market categories and their exact names.\n\n### Example\nA typical sequence dealing with our interfaces would be:\n```\n1. You query the Brands interface and match the brand names in Your products to the names in the received brands.\n2. You query the Categories interface and match the category names in Your products to the names in the received categories.\n3. You use the POST endpoints from the Products interface to send Your products to Otto Market\n4. You will receive 202 HTTP return code and a body like:\n{\n \"state\": \"pending\",\n \"message\": \"The process is currently in progress\",\n \"progress\": 0,\n \"total\": 2,\n \"pingAfter\": \"2020-05-13T10:40:01.815Z\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"/v3/products/update-tasks/09abe6ca-9c36-45bb-9cd3-a7de7f93284b\"\n },\n {\n \"rel\": \"failed\",\n \"href\": \"/v3/products/update-tasks/09abe6ca-9c36-45bb-9cd3-a7de7f93284b/failed\"\n },\n {\n \"rel\": \"succeeded\",\n \"href\": \"/v3/products/update-tasks/09abe6ca-9c36-45bb-9cd3-a7de7f93284b/succeeded\"\n },\n {\n \"rel\": \"unchanged\",\n \"href\": \"/v3/products/update-tasks/09abe6ca-9c36-45bb-9cd3-a7de7f93284b/unchanged\"\n }\n ]\n}\n5. You execute /v3/products/update-tasks/09abe6ca-9c36-45bb-9cd3-a7de7f93284b until the state changes to \"done\". Usually this will happen very fast.\n6. You execute /v3/products/update-tasks/09abe6ca-9c36-45bb-9cd3-a7de7f93284b/succeeded and /v3/products/update-tasks/09abe6ca-9c36-45bb-9cd3-a7de7f93284b/failed to watch the details of the processing (successfully imported products, and detailed information to failures which occurred in the product data processing).\n7. You may browse /v3/products/update-tasks/09abe6ca-9c36-45bb-9cd3-a7de7f93284b/unchanged to look at the product data which You delivered with the same content as in the former product data delivery.\n```\n\n### Authentication\nAll interfaces expect the consumer to add a valid JWT token to the request, otherwise the request will fail with HTTP 401 or 403\n\n### Rate Limits\nThe OTTO products-API serves billions of API calls every month. The following limits should create the best quality of service for all API users. Every endpoint has its own limits. Too many API calls will cause a HTTP 429 \"too many requests\" error:\n\n| Endpoint path | HTTP method | Max requests per time unit |\n| ------------- | ----------- | -------------------------- |\n| /products | GET | 10 per second |\n| /products | POST | 20 per second |\n| /products/prices | GET | 10 per second |\n| /products/prices | POST | 10 per second |\n| /products/active-status | GET | 10 per second |\n| /products/active-status | POST | 3600 per day |\n| /products/marketplace-status | GET | 10 per second |\n| /products/categories | GET | 10 per second |\n| /products/brands | GET | 10 per second |\n\n#### What to do if you hit the rate limits?\nIf you get responses with a ```429 Too many requests``` status we recommend parsing the ```Retry-After``` header of these responses. Your client then should wait until the specified amount of time has passed before making additional calls, or it may be subject to additional rate limiting.\n\n\n### HTML markup in free texts\nAll fields with free text values (like e.g. description, bullet points, certain category-dependent attributes) do only accept some of\nthe available HTML markup tags - every other markup will be removed,\n\nThe allowed tags are:\n\n* formatting tags
\n ```, , , , , , ^{, _{, , , , , , , , ,
, , ```\n* block tags
\n ```,
, ,
,
,
,
,
, , , , ```\n\nPLEASE NOTE: Although these tags are not removed directly, it cannot be guaranteed that all formatting and block definitions will be displayed as desired on the shop detail page.\n\n\n\n\n\n### Changelog\n\n| Date | Description |\n|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 2022-09-22 | We are proudly introducing our products API v3 with a lot of changes compared to v2, that we will describe here. Further information for v3 can also be found in the OPC-helpdesk. **v2 will be supported until 31th of March 2023.** After this date, the products interface will reject requests via v2.

**Changed**
- handling brands: We introduce the brandId, which will replace the name of the brand. You can find the brandIds and the matching brand-names at `v3/products/brands`. The new brandId keeps stable, even if the name of a brand will be adjusted in the future. The brandId allows us to seperate between different brands with the same name. The `usable`-tag at every brand gives you the information, if you are allowed to setup products from this brand or you need a special permission for that.
- restrict the length of the attributes `productLine`, `Besondere Merkmale` and `Set-Info` to 70 characters each. The product-title on otto.de is composed based on the selected category. You can find the title-templates in the category-endpoint. These 3 attributes are part of most title-templates. We need to restrict the length to avoid overly long product-titles, which have a bad influence on the customer experience.
- the status of an upload is now more transparent. We now differenciate just between the upload-state \"in progress\" and \"done\". The state \"failed\" isn't shown any more. For your convenience, we also show a more detailed status of the processing, which were included in the upload.
- The asset-links may contain a maximum of 2083 characters.
- Prices should be transmitted with Euro as currency and may contain 2 decimal places.

**Added**
- `deliveryType` offers a new value for goods, which have to be transported to customers by heavy trucks. It is called `FORWARDER_HEAVYDUTY`.
- You can now, if you wish, limit a customer's order in the number of items per order. This can make sense for products where demand is greater than supply. Additionally to the attribute `maxOrderQuantity` known from v2, you can limit the order with a specific period `periodInDays`. A `maxOrderQuantity` with a `quantity` of 5 and a `periodInDays` of 30 means, that a customer can order 5 pieces of this variation in 30 days.

**Removed**
- the attribute `offeringStartDate` is deleted
- `UPC` and `ISBN` are deleted |\n"},{"name":"Quantities-V2","description":"### Quantities interface\n\nOnce the products have been successfully transferred, only the quantities are missing to make the products available to the end customer on otto.de.\nFor this purpose the Quantity Interface allows partners and service providers to update the available quantity for a specific SKU (up to 200 SKUs per request). \nThe available quantity can be any integer value >= 0.\n\n\n### Changelog\n\n| Date | Description |\n| ---- | ----------- |\n| 2020-01-30 | **Added**
- added validation for accepting quantities for unknown skus.|\n| 2021-08-18 | **Added**
- get api v2/quantities to view available quantity of products.
- get api v2/quantities/{sku} to view available quantity of a particular product.|\n| 2021-09-28 | **Changed**
- remove partnerId from get api responses v2/quantities and v2/quantities/{sku}|\n| 2021-10-11 | **Updated**
- the get api v2/quantities to list all the products of a partner is not working as desired
- the get endpoint v2/quantities is still reachable, but the partner needs to update the quantities for all his products once or limit the products being returned in the response by setting the limit value to number of products they have updated.(v2/quantities?limit=no.of products).|\n| 2023-02-08 | **Updated**
- added cursor query parameter to v2/quantities GET endpoint |"},{"name":"Orders-V4","description":"### Order Interface\n\nThis interface allows partners and service providers to view orders and associated position items. It also allows sending cancellations on order and position item level.\n\nThe term *sales order* refers to a customer's order with items from different partners. The term *partner order* refers to a customer's order containing only the positions of a single partner.
\nThis interface is only concerned with partner orders.\n\nA position item is the physical product a customer has ordered. A checkout with a product quantity greater than one will produce unique position items within the partner order.\n\n### Authentication\n\nEvery operation on this interface requires proper credentials. Partners only have visibility on their own orders.\n\n\n### Fulfillment States\n\nA position item can stay in different fulfillment states (attribute 'fulfillmentStatus'):\n\n1. ANNOUNCED -> An ordered position item which shall be reserved for the customer but shall not be shipped yet. The position item can still be cancelled by the marketplace and the customer. The address of the customer is not visible in this state. \n2. PROCESSABLE -> This position item is ready to be fulfilled.\n3. SENT -> This position item was shipped. It was processed by the [Shipments interface](./docs#tag/Shipments-V1).\n4. RETURNED -> This position item was returned. It was processed by the [Returns interface](./docs#tag/Returns-V2).\n5. CANCELLED\\_BY\\_PARTNER -> This position item was cancelled by the partner and won't be processed any further.\n6. CANCELLED\\_BY\\_MARKETPLACE -> This position item was cancelled by the marketplace and won't be processed any further. In case of a partner termination all position items in state ANNOUNCED or PROCESSABLE will be cancelled.\n\n### Possible State Transitions\n\n\n\nThe position item states determine the whole order's lifecycle state:\n\n* The order will be classified as ANNOUNCED, PROCESSABLE, SENT, or RETURNED if at least one position item is in an analogous state **AND** all other position items have the same or higher state according to above-mentioned list.\n* The order will also be classified as CANCELLED\\_BY\\_MARKETPLACE or CANCELLED\\_BY\\_PARTNER if it has at least one position item in fulfillment state CANCELLED\\_BY\\_MARKETPLACE resp. CANCELLED\\_BY\\_PARTNER.\n\nThe latest lifecycle change is recorded in order attribute 'lifecycleChangeDate'. You can choose to quey by lifecycle state or position item state by using the ```mode```\n\n\n\n### Fetching Orders\n\nOrders can be fetched individually by ```salesOrderId```/ ```orderNumber``` or as a list by using different filter criteria.\n\n#### Common Use Cases\n\n##### Fetch open orders\n\nOrders can be constantly created. After the payment confirmation orders change to state PROCESSABLE. To fetch orders after they became processable this REST call can be used\n\n```\nGET /v4/orders?fulfillmentStatus=PROCESSABLE\n```\n\nIf there is a next link it can be followed until there are no new orders. To start at a certain date the fromDate can be used, which relates to the lifecycleChangeDate, which in this case is when order became PROCESSABLE. \n\n```\nGET /v4/orders?fulfillmentStatus=PROCESSABLE&orderColumnType=ORDER_LIFECYCLE_DATE&fromDate=2023-07-01T00:00:00Z\n```\n\nThis works in a similar way for other status and combinations, for example\n\n```\nGET /v4/orders?fulfillmentStatus=PROCESSABLE,SENT\n```\n\n##### Fetch all orders for a day\n\n```\nGET /v4/orders?fromOrderDate=2023-07-01T00:00:00Z&toOrderDate=2023-07-02T00:00:00Z&orderColumnType=ORDER_DATE\n```\n\nThe next link can be followed until there are no orders left. \n\n##### Fetch all orders with returned positions\n\nTo fetch orders with at least one returned position the following query can be used\n\n```\nGET /v4/orders?fulfillmentStatus=RETURNED&mode=AT_LEAST_ONE&orderColumnType=LAST_MODIFIED_DATE&fromDate=2023-07-01T00:00:00Z\n```\n\n##### Fetch a single order\n\nBy ```salesOrderId```\n\n```\nGET /v4/orders/82f3e02f-2f56-448d-8f3b-d42f5a475119\n```\n\nBy ```orderNumber```\n\n```\nGET /v4/orders/v8pnyhq2nh\n```\n\n#### Performance Hints\n\nThere can be a lot of combinations of parameters for the API which will result in varying response times. For best performance results try to use either ```fromDate``` or ```fromOrderDate```/ ```toOrderDate```, not both at the same time. Also orderColumnType works best with ```fromDate``` instead of ```fromOrderDate```/ ```toOrderDate```.\n\n\n#### Pagination\n\nPaging will occur if the number of returned orders exceeds the current limit (request parameter ```limit```).\n\n#### Example\n\n```\n{\n \"resources\": [\n { \n ...\n }\n ...\n ],\n \"links\": [\n {\n \"href\": \"/v4/orders?nextcursor=eyJmZiI6MTY4ODU0Mzk5MDUxMCwicGlmIjoiMTAwNjI1MCIsIm0iOiJCVUNLRVQiLCJvY3QiOiJPUkRFUl9MSUZFQ1lDTEVfREFURSIsIm9kIjoiQVNDIiwic3RmIjoic2FsZXNPcmRlcklkIiwibHNvaSI6ImUxM2IwYTMyLWU1ZTMtNDEwYi05YWQ2LTliZWRlY2MwNzVjNiIsInNvaWNyIjpmYWxzZX0\",\n \"rel\": \"next\"\n }\n ]\n}\n```\n\nUsing ```/v4/orders?nextcursor=eyJmZiI6MTY4ODU0Mzk5MDUxMCwicGlmIjoiMTAwNjI1MCIsIm0iOiJCVUNLRVQiLCJvY3QiOiJPUkRFUl9MSUZFQ1lDTEVfREFURSIsIm9kIjoiQVNDIiwic3RmIjoic2FsZXNPcmRlcklkIiwibHNvaSI6ImUxM2IwYTMyLWU1ZTMtNDEwYi05YWQ2LTliZWRlY2MwNzVjNiIsInNvaWNyIjpmYWxzZX0``` here would receive the next slice of records; a missing next link indicates no further records.\n\n\n\n\n### Cancellation\n\nPosition items of an order can be cancelled. These position items must be in state PROCESSABLE or ANNOUNCED.
\n**Partner cancellations in general lead to customer dissatisfaction and should be avoided.**\n\nCancellation is possible for only a single position item or the whole order:\n\n- to cancel a single position item send a POST request '/v4/orders/{salesOrderId}/positionItems/{positionItemId}/cancellation'\n- to cancel the whole order send a POST request '/v4/orders/{salesOrderId}/cancellation'\n\nEvery position item which is in fulfillment status PROCESSABLE or ANNOUNCED will be changed to CANCELLED\\_BY\\_PARTNER. If there was a cancellation request from the customer the ```cancellationReason``` will be set to CANCELLED_ON_CUSTOMER_WISH\n\nThe cancellation operations might take a moment until the result is visible on a subsequent fetch request. Conflicts will be reported in an error response.\n\n\n### Changelog\n\nThis changelog will document all relevant changes in our interface. \nKudos to https://keepachangelog.com/de/1.0.0/\n\n\n| Date | Description |\n|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 2022-10-04 | In this release the visibility of partner orders has been adapted.
**Changed**
- All partner orders will now show up instantly in the status ANNOUNCED (regardless of the payment method). Once the time period has exceeded in which the customer can still cancel an order, the respective position items will transition to PROCESSABLE status. If the customer has actually cancelled a position item or an entire order, the respective position items will change their status to CANCELLED_BY_MARKETPLACE with a cancellation reason of CANCELLED_ON_CUSTOMER_WISH. |\n| 2022-05-11 | In this release a new field **dimensions** has been added to the product object in the position items.
**Added**
- New field **dimensions** has been added to the product on the position item level. It describes the different dimensions of a product from the marketplace. |\n| 2021-11-04 | In this release a new field **cancellationReason** has been added to position items.
**Added**
- New field **cancellationReason** has been added on position item level, which describes the reason for a cancellation of an item. |\n| 2021-11-01 | In this release a new field **weeePickup** has been added to position items.
**Added**
- New optional field **weeePickup** has been added on position item level. This field indicates whether customer requested a disposal service as per \"Waste from Electrical and Electronic Equipment\" (WEEE) regulation. |\n| 2021-10-19 | In this release the error message handling has been expanded.
**Added**
- On all endpoints the error response 403 will be given if access role is missing; will include a body conforming to the common error message style. |\n| 2021-10-18 | In this release a new object **payment** has been added.
**Added**
- New optional object **payment** has been added on partner order level. It includes the **paymentMethod** field, which describes the chosen payment method. |\n| 2021-08-30 | In this release GDPR relevant changes were delivered.
**Changed**
- The objects **deliveryAddress** and **invoiceAddress** of an order (optional since v4) are not provided for orders after 8 weeks after all position items have reached either status SENT or any of the CANCELLED states, i.e. no position item is in BLOCKED or PROCESSABLE status. Both the fields **email** and **phoneNumber** are no longer provided after 4 weeks. |\n| 2021-08-25 | In this release new date field **processableDate** has been added.
**Added**
- New optional field **processableDate** has been added on partner position item level, which describes when a position item has reached PROCESSABLE status. |\n| 2021-05-21 | In this release new date field **expectedDeliveryDate** has been added.
**Added**
- New optional field **expectedDeliveryDate** has been added on partner position item level, which describes when the customer expects the delivery. |\n| 2021-04-30 | This is the first release of version 4 (v4) of the Orders API. Compared to version 3 (v3) we introduced the following changes. (v3 has been deprecated with the release of v4. It is planned to take v3 offline by 2021-10-31 at the earliest.)

**Added**
- Used customer discounts (optional field **initialDiscounts**) are now part of the received order documents.
- All error responses (4xx) include a body conforming to the common error message style.

**Changed**
- The type of product items' VAT rate changed to *number* (used to be of type *string*).
- Delivery fees of an order are contained in array **initialDeliveryFees** instead of **initialServiceFees**.
- Like prices, delivery fees and discounts now have a dedicated monetary object **deliveryFeeAmount** resp. **discountAmount**.
- In case of a conflict while cancelling multiple position items the error response provides details for every failed item.
- The fields **deliveryAddress** and **invoiceAddress** of an order have become optional - these fields are not provided for orders with all position items in state ANNOUNCED or CANCELLED\\_BY\\_MARKETPLACE.
- In paginated responses the 'links' attribute will no longer appear if there are no further records (used to be an empty array)

**Removed**
- Within the query for orders the parameters 'searchTerm' and 'searchTermField' are no longer available. |\n\n\n"},{"name":"ReturnShipments-V1","description":"### ReturnShipments Interface\n\nThis interface should be used to find return shipments which have been handed over to the carrier for final delivery to the partner. \nAt the beginning of the process the customer has to create a return label for his shipment (to be returned).\nThis is the trigger for a continuous query of the tracking status with its specific carrier.\n\nYou can use the GET endpoints to retrieve information of your return shipments in the OTTO Market. \n\n\n\n\n\n### Changelog\n\nThis changelog will document all relevant changes in our interface.
\nKudos to https://keepachangelog.com/de/1.0.0/\n\n| Date | Description |\n|--------------|--------------------------------------------------------------------------------------------------------------------------------|\n| 2023-07-06 | **Changed**
- changed ReturnShipmentState order |\n| 2023-07-06 | **Changed**
- Add new ReturnShipmentState ANNOUNCED |\n| 2023-04-14 | **Changed**
- Fixed the name of 'creationDate' to 'createdAt' to match the actual implementation, added some documentation |\n| 2023-03-27 | **Changed**
- Go live of API Definition |\n| 2023-02-10 | **Changed**
- Change name of id consistently to returnShipmentId |\n| 2023-02-10 | **Changed**
- Fixed property names of ReturnPositionItems |\n| 2023-02-07 | **Changed**
- return-shipments endpoint returns list of full return-shipments, removed ReturnShipmentsWithMinimumDetails |\n| 2022-12-12 | **Added**
- first version of the API Definition |\n"},{"name":"Shipments-V1","description":"### Shipment Interface\n\nThis interface should be used to report that shipments have been handed over to the carrier for final delivery to the customer. \nAt this point, the position items within the shipment are marked with the state ''SENT'' in the OTTO Market. This is the trigger for the generation of a purchase receipt.\n\nYou can use the GET endpoints to retrieve information of your shipments in the OTTO Market. \n\n\n\n\n\n### Changelog\n\nThis changelog will document all relevant changes in our interface.
\nKudos to https://keepachangelog.com/de/1.0.0/\n\n| Date | Description |\n|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 2023-03-22 | **Changed**
- Added endpoint for multiparcel-shipments. |\n| 2022-09-12 | **Changed**
- Deleted field returnAddressCarrierId from the Documentation, field no longer needed in the request. |\n| 2022-07-12 | **Added**
- added new field returnAddressCarrierId, unique id for the return address and the return carrier combination. Backend logic not deployed in live yet. |\n| 2022-06-24 | **Added**
- added authorization to the endpoints and use new roles separated for read and write |\n| 2022-05-01 | **Added**
- add new ShipmentStates array to Shipments
- add add new ShipmentStates array to ShipmentWithMinimumDetails objects |\n| 2020-07-02 | **Added**
- add new carrier \"DHL_HOME_DELIVERY\"
- add new optional property _jsonPath_ to _ErrorDescription

**Changed**
rework of the validation of the request body for better user experience as version 1.1.0
- better error messages in _title_ and _detail_ properties of _ErrorDescription_
- a new optional property _jsonPath_ in _ErrorDescription_ to imply where the error happened
- multiple _ErrorDescription_ in _BadRequest_, _BadRequestAddPositionItemByTrackingNumber_ and _BadRequestAddPositionItemByShipmentId_ possible |\n| 2020-03-31 | **Changed**
- add length restriction to shipFromAddress.city and shipFromAddress.zipCode |\n| 2020-02-12 | **Added**
- add some examples for CreateShipmentRequest for carrier \"OTHER_FORWARDER\" |\n| 2020-01-14 | **Added**
- support of utc timestamps with offsets for shipDate |\n| 2019-11-07 | **Changed**
- changed carrier OTHER to OTHER_FORWARDER |\n| 2019-10-25 | **Added**
added new carrier or forwarder
- DHL_FREIGHT
- HES
- HELLMANN
- DB_SCHENKER
- IDS
- EMONS
- DACHSER
- LOGWIN
- KUEHNE_NAGEL
- SCHOCKEMOEHLE
- KOCH
- REITHMEIER
- OTHER

**Changed**
- added more detailed description

**Removed**
- removed carrier OTHERS |\n| 2019-08-29 | **Changed**
- renamed carrier and returnCarrier 'HERMES_GERMANY' to 'HERMES' |\n| 2019-08-14 | **Changed**
- type of shipmentId changed from integer to string |\n"},{"name":"Returns-V2","description":"### Returns Interface\n\nAfter you have sent the product to the customer, but the customer has unfortunately decided not to keep it, this Returns Interface allows you to report the return.\n\nIn principle, you will accept a return, so that we can trigger the customer payment immediately. It would be great if you would also inform us about the condition of the return.\n\nIn the rare case (e.g. if the return does not correspond to the correct article) that you do not want to accept a return, you also have the option to reject the return. In this case we would like to receive a reason in addition to the condition of the return.\n\nReject reason is a free text where you can tell us why you are rejecting the return. This will help us understand and if possible, reduce \"bad\" returns. \nSome examples of return reasons could be \"Not my product\", \"Returned later than is allowed to\", \"Possible fraud\", \"Non-returnable item\" etc.\"\n\nWe expect the following values for the condition:\n\t\n* A for \"in original packaging\" \n* B for \"in mint condition\"\n* C for \"slightly used\"\n* D for \"heavily used\"\n* E for \"mistake (Delivery incomplete, not available,...)\"\n\nIf you have already accepted a return, it cannot be rejected again afterwards. However, if you feel you have changed your mind about a rejected return, you still have the option to accept the return afterwards.\n\n\n### Changelog\n\nThis changelog will document all relevant changes in our interface.
\nKudos to https://keepachangelog.com/de/1.0.0/\n\n\n| Date | Description |\n| ---- | ----------- |\n| 2023-04-11 | **Updated**
- Updated 500 error content for /v2/returns api.|\n| 2023-04-11 | **Updated**
- Updated 500 error document for /v2/returns api.|\n| 2021-05-10 | **Updated**
- Updated positionItemId examples for /v2/returns api.|\n| 2021-04-30 | **Updated**
- Updated examples for /v2/returns api.| \n| 2021-02-04 | **Updated**
- Updated get api /v2/returns limit description.| \n| 2020-05-05 | **Updated**
- Updated Rejected Returns Api Description.| \n| 2020-04-13 | **Added**
- validation to post api /v2/returns to check if the salesOrderId is valid.|\n| 2020-02-17 | **Added**
- get api /v2/returns to view returns accepted and return rejected by customer.|\n| 2019-10-25 | **Added**
- get api /v2/returns to view returns announced by customer and misdirected at otto warehouse.|\n| 2019-10-25 | **Updated**
- Updated allowed enum values for /v2/returns status parameter
- Changed GET /v2/returns status parameter from required to optional
- Updated 200 response example for /v2/returns |\n"},{"name":"Receipts-V3","description":"### Receipts Interface\n\nUsing this API, partners and/or their service provider can get all receipts generated in their name in context of B2C\nprocesses to document the billing process on OTTO Market.\n\n⚠ **Please for your own interest, hand over all receipt types you are interested in using the new list parameter receiptTypes, so that OTTO Market could add new receipt types without side effects for your own processes.**
\n**Using this option you can decide by your own when to incorporate new receipt types in your own processes.**
\n**Please do not use the possibility of calls without specifying the receiptTypes anymore.**\n\nAll receipt types currently exists in live environment:\n\n- **PURCHASE**
\n A purchase receipt (also called an invoice) documents what prices charged by the customer at the time of sales, taking\n into account granted discounts.\n The receipt contains information per order, partner and shipment. It is created when items are shipped to the\n customer. Each item or service is invoiced exactly once. So that there can be more than one receipt per order.\n Shipping costs are charged only once per partner and order and are shown only once in case of partial shipments of an\n order.\n Surcharges levied by a payment provider on the customer when using special payment conditions are not part of the\n receipts of OTTO Market.\n- **REFUND**
\n We distinguish different types of reimbursement documents. A refund receipt documents the a customer's claim of\n reimbursement.\n This receipt is currently created when returned items are accepted. A refund receipt normally contains at least an\n item or service. In very rare cases, however, refund receipts can also be created in context of the cancellation\n process to repay shipping costs only billed for full returns.\n Earlier partial refunds are taken into account.\n- **PARTIAL_REFUND**
\n We distinguish different types of reimbursement documents. A partial refund receipt documents a customer's claim of\n reimbursement.\n Different reasons are possible for partner to trigger such a receipt. For example a partial refund of an item price as\n a gesture of goodwill to avoid returns\n\nOn all documents you will usually find\n\n- item/service details\n- shipped quantities\n- delivery costs\n- payment details\n- customer details\n- partner details\n\nSome details can only be found on the pdf documents. These include for example:\n\n- Company logo of OTTO (as operator of OTTO Market)\n- Company details of financial service providers\n- Contact details of OTTO (as relation center operator for customer inquiries and complaints)\n\nGeneral information:\n\n- Pdf documents are only generated once and do not change over time.\n- When a pdf is generated, dates are printed on the pdf documents in format DD.MM.YYYY in time zone (CET/CEST) from\n Germany.\n- Currently, we provide receipts that are up to 4 years old. We could not guarantee this forever, so it would be good,\n if you plan to get receipts always periodically.\n\nBelow you find the end points which can use to retrieve this information from the Receipts API.\n\n### Interested in some more details?\n\n\nRough class diagram of JSON representation of receipt (Click to Expand)\n
\n⚠ This class diagram only shows the main objects to show the general structure. More information about the missing objects can be found in the field description.\n\n\n* **Receipt** - Collection of all details of a receipt. A receipt can have different receiptTypes\n* **Customer** - Customer details\n* **Address** - Address entered by customer during the order process. Recipient can be a person or a pickup point.\n* **Partner** - Partner details when generating the receipt\n* **LineItems** - Block of receipt line items\n * **ItemPosition** - Representation of an item
Never used in context of receipts of receiptType PARTIAL_REFUND\n * **DeliveryCost** - Representation of delivery cost like delivery fee or freight surcharge
Never used in context of receipts of receiptType PARTIAL_REFUND\n * **ServicePosition** - Representation of a service
Never used in context of receipts of receiptType PARTIAL_REFUND\n * **ItemPartialRefundPosition** - Reduction of an item price granted by a receipt of receiptType PARTIAL_REFUND\n * **PriceModification** - PriceModification objects represent price increases and decreases of individual line item objects.
Currently we only know decreases granted instandly or at a later point in time.
On the pdf documents increases and decreases do not necessarily have to be shown on the same line. If there is a discrepancy, it is visible by different line numbers of this object and the parent line item object.
Different PriceModification objects of same type are possible.\n * **ServicePartialRefundPosition** - Reduction on a service price granted by a receipt of receiptType PARTIAL_REFUND\n * **DeliveryFeePartialRefundPosition** - Reduction on delivery costs granted by a receipt of receiptType PARTIAL_REFUND\n* **Payment** - Payment details\n* **TotalsReduction** - Reduction on receipt level\n
\n\n\n### Changelog\n\nThis changelog will document all relevant changes in our interface.
\nKudos to https://keepachangelog.com/de/1.0.0/\n\n| Date | Description |\n| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 2023-09-07 | **Added** Add new query parameter `next` to endpoint `GET /v3/receipts`

**Deprecated** Parameter `page` is deprecated
|\n| 2023-08-09 | **Added** Add new value `PAYPAL` to `paymentMethod`
|\n| 2023-06-19 | **Added** Add `type` in the `details` of the price modifications
|\n| 2023-06-19 | **Added** Add `priceModifications` field in the `servicePositions`
Add `servicePartialRefundPositions` field in the `lineItems`
Add `deliveryFeePartialRefundPositions` field in the `lineItems`
Add `partialRefundDetails` in the `itemPartialRefundPositions`
Add `partialRefundType` for **PARTIAL_REFUND** receipt
Add `reason` for **PARTIAL_REFUND** receipt
**Updated** Update `priceModificationType` in the price modifications
Update `description` in the `details` of the price modifications
|\n| 2023-05-31 | **Added** Add `totalsReductions` field
Add `priceToPayPerSalesOrderPositionItems` field for **PURCHASE** receipt
|\n| 2023-04-26 | **Added** Add `refundType` as optional field for refund receipt
|\n| 2023-01-11 | We are proudly introducing our receipts API v3 with a lot of changes compared to v2, that we will describe here. **v2 will be supported until 11th of July 2023.** After this date, the receipts interface will reject requests via v2.

**Changed**
- _sales_order_id_ query parameter filter has been renamed to _salesOrderId_ for /receipts endpoint
- _type_ has been renamed to _receiptType_
- _originalReceiptNumber_ has been renamed to _linkedReceiptNumber_
- _originalCreationDate_ has been renamed to _linkedCreationDate_
- _lineItems_ was used for only item positions previously, now there is a sub structure that cares about all bill objects
- _partner.name_ has been renamed to _partner.partnerName_
- _partner.legalRepresentatives_ has been renamed to _partner.representedBy_
-_partner.registerNumber_ has been renamed to _partner.commercialRegisterNumber_
- _customer.street_ will not contain house number for newly created receipts
-_articleNumber_ will contain promotion as suffix
- _lineItems.dimensions_ has been renamed to _lineItems.itemPositions.variationAttributes_
- _amountDue_ will contain the actual amount due from customer
- _shippingCost_ has been renamed to _deliveryCost_
- _vatRate_ has been renamed to _taxRate_
- _vat_ has been renamed to _tax_

**Added**
- Introduce _receiptTypes_, _from_ and _to_ new query parameter filters for /receipts endpoint
- _isRealReceipt_ will indicate whether its a real invoice or technical invoice
- _customer.houseNumber_ will contain house number of the customer
- _deliveryAddress.houseNumber_ will contain house number of the delivery address
- Introduce _totals_ to contains total amount per tax type and tax rate
- Introduce _totalsGrossAmount_ as summation of total receipt amount including all tax type

**Removed**
- _url_ and _priceToPay_ has been removed
- _type_ query parameter filter has been removed for /receipts endpoint

More changes can be found on swagger documentation |\n"},{"name":"Price-Reductions-V1","description":"### Price Reductions Interface\n\nThis endpoint enables sellers to apply price reductions to shipped products if the product has issues, or the customer is unsatisfied. \nIt´s also possible to view previously applied price reductions. \nPrice reductions can only be applied after products have been marked as shipped.\n\n### Changelog\n\nThis changelog will document all relevant changes in our interface.
\nKudos to https://keepachangelog.com/de/1.0.0/\n\n\n| Date | Description |\n| ---- | ----------- |\n| 2022-01-19 | **Added**
- price reduction APIs"}]}}}