Some example words...in bold...some more
\",\"bulletPoints\":[\"My top key information...\"],\"attributes\":[{\"name\":\"Materialzusammensetzung\",\"values\":[\"100% Baumwolle\"],\"additional\":false}]},\"mediaAssets\":[{\"type\":\"IMAGE\",\"location\":\"http://apartners.url/image-location\"}],\"order\":{\"maxOrderQuantity\":{\"quantity\":10,\"periodInDays\":7}},\"pricing\":{\"standardPrice\":{\"amount\":19.95,\"currency\":\"EUR\"},\"vat\":\"FULL\",\"msrp\":{\"amount\":19.95,\"currency\":\"EUR\"},\"sale\":{\"salePrice\":{\"amount\":19.95,\"currency\":\"EUR\"},\"startDate\":\"2019-10-19T09:30:00Z\",\"endDate\":\"2019-10-19T09:30:00Z\"},\"normPriceInfo\":{\"normAmount\":100,\"normUnit\":\"g\",\"salesAmount\":500,\"salesUnit\":\"g\"}},\"logistics\":{\"packingUnitCount\":3,\"packingUnits\":[{\"weight\":365,\"width\":600,\"height\":200,\"length\":300}]},\"compliance\":{\"productSafety\":{\"addresses\":[{\"name\":\"Die Musterfirma GmbH\",\"address\":\"Musterstraße 1, 12345, Musterstadt, Deutschland\",\"regionCode\":\"DE\",\"email\":\"info@die-musterfirma.de\",\"url\":\"https://musterfirma/kontakt-information\",\"phone\":\"+ 49 40 123456789\",\"roles\":[\"DISTRIBUTOR\"],\"components\":[\"mouse\"]}]},\"foodInformation\":{\"addresses\":[{\"name\":\"Die Musterfirma GmbH\",\"address\":\"Musterstraße 1, 12345, Musterstadt, Deutschland\",\"regionCode\":\"DE\",\"email\":\"info@die-musterfirma.de\",\"url\":\"https://musterfirma/kontakt-information\",\"phone\":\"+ 49 40 123456789\",\"roles\":[\"FOOD_BUSINESS_OPERATOR\"],\"components\":[\"Salad\"]}]}}}]'" }, { "lang": "Shell + Httpie", "source": "echo '[{\"productReference\":\"UBN-11779\",\"sku\":\"3858389911564\",\"ean\":\"3858389911564\",\"pzn\":\"PZN-4908802\",\"mpn\":\"H2G2-42\",\"moin\":\"M00A1234BC\",\"releaseDate\":\"2019-10-19T00:00:00Z\",\"productDescription\":{\"category\":\"Outdoorjacke\",\"brandId\":\"CMWBBRW2\",\"productLine\":\"501\",\"productionDate\":\"2021-07-02T09:30:52.093Z\",\"multiPack\":true,\"bundle\":false,\"fscCertified\":true,\"disposal\":false,\"productUrl\":\"http://myproduct.somewhere.com/productname/\",\"description\":\"Some example words...in bold...some more
\",\"bulletPoints\":[\"My top key information...\"],\"attributes\":[{\"name\":\"Materialzusammensetzung\",\"values\":[\"100% Baumwolle\"],\"additional\":false}]},\"mediaAssets\":[{\"type\":\"IMAGE\",\"location\":\"http://apartners.url/image-location\"}],\"order\":{\"maxOrderQuantity\":{\"quantity\":10,\"periodInDays\":7}},\"pricing\":{\"standardPrice\":{\"amount\":19.95,\"currency\":\"EUR\"},\"vat\":\"FULL\",\"msrp\":{\"amount\":19.95,\"currency\":\"EUR\"},\"sale\":{\"salePrice\":{\"amount\":19.95,\"currency\":\"EUR\"},\"startDate\":\"2019-10-19T09:30:00Z\",\"endDate\":\"2019-10-19T09:30:00Z\"},\"normPriceInfo\":{\"normAmount\":100,\"normUnit\":\"g\",\"salesAmount\":500,\"salesUnit\":\"g\"}},\"logistics\":{\"packingUnitCount\":3,\"packingUnits\":[{\"weight\":365,\"width\":600,\"height\":200,\"length\":300}]},\"compliance\":{\"productSafety\":{\"addresses\":[{\"name\":\"Die Musterfirma GmbH\",\"address\":\"Musterstraße 1, 12345, Musterstadt, Deutschland\",\"regionCode\":\"DE\",\"email\":\"info@die-musterfirma.de\",\"url\":\"https://musterfirma/kontakt-information\",\"phone\":\"+ 49 40 123456789\",\"roles\":[\"DISTRIBUTOR\"],\"components\":[\"mouse\"]}]},\"foodInformation\":{\"addresses\":[{\"name\":\"Die Musterfirma GmbH\",\"address\":\"Musterstraße 1, 12345, Musterstadt, Deutschland\",\"regionCode\":\"DE\",\"email\":\"info@die-musterfirma.de\",\"url\":\"https://musterfirma/kontakt-information\",\"phone\":\"+ 49 40 123456789\",\"roles\":[\"FOOD_BUSINESS_OPERATOR\"],\"components\":[\"Salad\"]}]}}}]' | \\\n http POST https://api.otto.market/v5/products \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN' \\\n X-Request-Timestamp:2000-10-31T01:30:10.000-05:00 \\\n content-type:application/json" } ] } }, "/v5/products/active-status": { "get": { "security": [ { "bearerAuth": [ "products" ] } ], "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.", "operationId": "Products-V5__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-V5" } } }, "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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url 'https://api.otto.market/v5/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/v5/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": { "security": [ { "bearerAuth": [ "products" ] } ], "description": "Returns a process-id to query results. The limit for the number of product active statuses in one request is 500.", "operationId": "Products-V5__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-V5" } } } }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProcessProgress__Products-V5" } } }, "description": "The request for a modification of the active status 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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request POST \\\n --url https://api.otto.market/v5/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\":[{\"sku\":\"82388894-5883-488\",\"active\":true}]}'" }, { "lang": "Shell + Httpie", "source": "echo '{\"status\":[{\"sku\":\"82388894-5883-488\",\"active\":true}]}' | \\\n http POST https://api.otto.market/v5/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" } ] } }, "/v5/products/brands": { "get": { "security": [ { "bearerAuth": [ "products" ] } ], "parameters": [ { "$ref": "#/components/parameters/If-Match" }, { "$ref": "#/components/parameters/If-None-Match" }, { "$ref": "#/components/parameters/If-Modified-Since" }, { "$ref": "#/components/parameters/If-Unmodified-Since" }, { "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" } ], "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-V5__getBrands", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandListResponse__Products-V5" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Last-Modified": { "$ref": "#/components/headers/Last-Modified" } }, "description": "successful operation" }, "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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url 'https://api.otto.market/v5/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/v5/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'" } ] } }, "/v5/products/categories": { "get": { "security": [ { "bearerAuth": [ "products" ] } ], "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-V5__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" }, { "description": "read a single category", "explode": true, "in": "query", "name": "category", "required": false, "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryGroups__Products-V5" } } }, "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." }, "404": { "description": "The category could not be found." } }, "summary": "Read product categories", "tags": [ "Products V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url 'https://api.otto.market/v5/products/categories?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&category=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'" }, { "lang": "Shell + Httpie", "source": "http GET 'https://api.otto.market/v5/products/categories?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&category=SOME_STRING_VALUE' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'" } ] } }, "/v5/products/content-changes": { "get": { "security": [ { "bearerAuth": [ "products" ] } ], "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-V5__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-V5" } } }, "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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url 'https://api.otto.market/v5/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/v5/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'" } ] } }, "/v5/products/marketplace-status": { "get": { "security": [ { "bearerAuth": [ "products" ] } ], "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-V5__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" }, { "description": "Define the sort order of the resulting entries. Available values are 'desc' for 'newest lastModified first' and 'asc' for 'oldest lastModified first' - default is 'desc'", "explode": true, "in": "query", "name": "sort-order", "required": false, "schema": { "enum": [ "desc", "asc" ], "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketPlaceStatusApiResult__Products-V5" } } }, "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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url 'https://api.otto.market/v5/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&sort-order=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'" }, { "lang": "Shell + Httpie", "source": "http GET 'https://api.otto.market/v5/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&sort-order=SOME_STRING_VALUE' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'" } ] } }, "/v5/products/prices": { "get": { "security": [ { "bearerAuth": [ "products" ] } ], "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-V5__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-V5" } } }, "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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url 'https://api.otto.market/v5/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/v5/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": { "security": [ { "bearerAuth": [ "products" ] } ], "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-V5__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-V5" }, "type": "array" } } } }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductProcessProgress__Products-V5" } } }, "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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request POST \\\n --url https://api.otto.market/v5/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 '[{\"sku\":\"string\",\"standardPrice\":{\"amount\":19.95,\"currency\":\"EUR\"},\"sale\":{\"salePrice\":{\"amount\":19.95,\"currency\":\"EUR\"},\"startDate\":\"2019-10-19T09:30:00Z\",\"endDate\":\"2019-10-19T09:30:00Z\"}}]'" }, { "lang": "Shell + Httpie", "source": "echo '[{\"sku\":\"string\",\"standardPrice\":{\"amount\":19.95,\"currency\":\"EUR\"},\"sale\":{\"salePrice\":{\"amount\":19.95,\"currency\":\"EUR\"},\"startDate\":\"2019-10-19T09:30:00Z\",\"endDate\":\"2019-10-19T09:30:00Z\"}}]' | \\\n http POST https://api.otto.market/v5/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" } ] } }, "/v5/products/update-tasks/{processUuid}": { "get": { "security": [ { "bearerAuth": [ "products" ] } ], "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-V5__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-V5" } } }, "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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url https://api.otto.market/v5/products/update-tasks/%7BprocessUuid%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'" }, { "lang": "Shell + Httpie", "source": "http GET https://api.otto.market/v5/products/update-tasks/%7BprocessUuid%7D \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'" } ] } }, "/v5/products/update-tasks/{processUuid}/failed": { "get": { "security": [ { "bearerAuth": [ "products" ] } ], "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-V5__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-V5" } } }, "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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url https://api.otto.market/v5/products/update-tasks/%7BprocessUuid%7D/failed \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'" }, { "lang": "Shell + Httpie", "source": "http GET https://api.otto.market/v5/products/update-tasks/%7BprocessUuid%7D/failed \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'" } ] } }, "/v5/products/update-tasks/{processUuid}/succeeded": { "get": { "security": [ { "bearerAuth": [ "products" ] } ], "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-V5__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-V5" } } }, "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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url https://api.otto.market/v5/products/update-tasks/%7BprocessUuid%7D/succeeded \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'" }, { "lang": "Shell + Httpie", "source": "http GET https://api.otto.market/v5/products/update-tasks/%7BprocessUuid%7D/succeeded \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'" } ] } }, "/v5/products/update-tasks/{processUuid}/unchanged": { "get": { "security": [ { "bearerAuth": [ "products" ] } ], "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-V5__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-V5" } } }, "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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url https://api.otto.market/v5/products/update-tasks/%7BprocessUuid%7D/unchanged \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'" }, { "lang": "Shell + Httpie", "source": "http GET https://api.otto.market/v5/products/update-tasks/%7BprocessUuid%7D/unchanged \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'" } ] } }, "/v5/products/{sku}": { "get": { "security": [ { "bearerAuth": [ "products" ] } ], "description": "Returns a single product variation by SKU.", "operationId": "Products-V5__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-V5" } } }, "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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url https://api.otto.market/v5/products/%7Bsku%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'" }, { "lang": "Shell + Httpie", "source": "http GET https://api.otto.market/v5/products/%7Bsku%7D \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'" } ] } }, "/v5/products/{sku}/active-status": { "get": { "security": [ { "bearerAuth": [ "products" ] } ], "description": "Returns active status of the requested product variation by SKU.", "operationId": "Products-V5__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-V5" } } }, "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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url https://api.otto.market/v5/products/%7Bsku%7D/active-status \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'" }, { "lang": "Shell + Httpie", "source": "http GET https://api.otto.market/v5/products/%7Bsku%7D/active-status \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'" } ] } }, "/v5/products/{sku}/content-changes": { "get": { "security": [ { "bearerAuth": [ "products" ] } ], "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-V5__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 ISO8601 date 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-V5" } } }, "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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url 'https://api.otto.market/v5/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/v5/products/%7Bsku%7D/content-changes?fromDate=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'" } ] } }, "/v5/products/{sku}/marketplace-status": { "get": { "security": [ { "bearerAuth": [ "products" ] } ], "description": "Returns marketplace status for a single product variation by SKU.", "operationId": "Products-V5__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-V5" } } }, "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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url https://api.otto.market/v5/products/%7Bsku%7D/marketplace-status \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'" }, { "lang": "Shell + Httpie", "source": "http GET https://api.otto.market/v5/products/%7Bsku%7D/marketplace-status \\\n Authorization:'Bearer REPLACE_BEARER_TOKEN'" } ] } }, "/v5/products/{sku}/prices": { "get": { "security": [ { "bearerAuth": [ "products" ] } ], "description": "Read the price data of a single product variation.", "operationId": "Products-V5__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-V5" } } }, "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 V5" ], "x-codeSamples": [ { "lang": "Shell + Curl", "source": "curl --request GET \\\n --url https://api.otto.market/v5/products/%7Bsku%7D/prices \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'" }, { "lang": "Shell + Httpie", "source": "http GET https://api.otto.market/v5/products/%7Bsku%7D/prices \\\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" } }, { "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" } }, { "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" } }, { "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-V5" }, "type": "array" } }, "required": [ "brandId", "category" ], "type": "object" }, "ProductLink__Products-V5": { "type": "object" }, "ProductProcessProgress__Products-V5": { "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", "example": 7 }, "progress": { "description": "the fraction of work that is already completed, as compared to the total work", "format": "int32", "type": "integer", "example": 7 }, "succeeded": { "description": "the number of successfully processed variations", "format": "int32", "type": "integer", "example": 4 }, "failed": { "description": "the number of failed processed variations", "format": "int32", "type": "integer", "example": 2 }, "unchanged": { "description": "the number of unchanged and not processed variations", "format": "int32", "type": "integer", "example": 1 }, "pingAfter": { "description": "recommendation when to poll this resource again to receive a meaningful update - ISO8601 date", "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-V5" }, "type": "array" } }, "type": "object" }, "ProductProcessResult__Products-V5": { "properties": { "results": { "items": { "$ref": "#/components/schemas/ProductProcessTaskResult__Products-V5" }, "type": "array" } }, "type": "object" }, "ProductProcessResultLink__Products-V5": { "properties": { "rel": { "description": "link relation type", "enum": [ "self", "failed", "succeeded", "unchanged" ], "type": "string", "example": "self" }, "href": { "description": "the linked reference as URI", "example": "/v5/products/update-tasks/11111111-0003-4444-9999-bbbbbbbbbbbbb", "type": "string" } }, "type": "object" }, "ProductProcessTaskError__Products-V5": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "path": { "type": "string" }, "jsonPath": { "type": "string" }, "logref": { "type": "string" } }, "type": "object" }, "ProductProcessTaskResult__Products-V5": { "properties": { "variation": { "type": "string" }, "errors": { "items": { "$ref": "#/components/schemas/ProductProcessTaskError__Products-V5" }, "type": "array" } }, "type": "object" }, "ProductVariation__Products-V5": { "properties": { "productReference": { "description": "The productReference groups all variations, that you want to combine into one product. This is not visible to the customer. The productReference can be freely assigned and may consist of maximum 50 characters. You can only use the productReference once within your product catalog. You should therefore use a value that makes sense for all variations of the product and does not refer to any specifics of a particular variation. You will find the product reference, for example, in the product overview in the portal.", "example": "UBN-11779", "type": "string" }, "sku": { "description": "Identifier for a product variation, provided by the partner, must be unique for a partner. It is mandatory, may consist of a maximum of 50 characters and must not contain leading or trailing spaces or non-printable Unicode control characters.", "example": "3858389911564", "type": "string" }, "ean": { "description": "External identifier of a product, must be unique in a partner assortment, must not start with a 2.", "example": "3858389911564", "type": "string" }, "pzn": { "description": "Pharmazentralnummer, a german standard for identifying pharmaceutical products.", "example": "PZN-4908802", "type": "string" }, "mpn": { "description": "Manufacturer part number, may consist of a maximum of 50 characters.", "example": "H2G2-42", "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" }, "releaseDate": { "description": "ISO8601 Date (e.g. 2024-08-01T08:00:00+0100) on which the product is released by the manufacturer, e.g. computer games.", "example": "2019-10-19T00:00:00Z", "format": "date-time", "type": "string" }, "productDescription": { "$ref": "#/components/schemas/ProductDescription__Products-V5" }, "mediaAssets": { "description": "A list of media assets describing this product variation. Currently these may only be static images of the types JPG or PNG with a RGB color space. Furthermore the images have to have a minimum size of 500 x 1000 pixel and a maximum width of 4500 pixel. Requirements for media assets can be found at https://account.otto.market/s/article/Vorgaben-fuer-Produktbilder", "items": { "$ref": "#/components/schemas/MediaAsset__Products-V5" }, "type": "array" }, "order": { "$ref": "#/components/schemas/Order__Products-V5" }, "pricing": { "$ref": "#/components/schemas/Pricing__Products-V5" }, "logistics": { "$ref": "#/components/schemas/Logistics__Products-V5" }, "compliance": { "$ref": "#/components/schemas/ProductCompliance__Products-V5" } }, "required": [ "ean", "productReference", "sku", "productDescription", "pricing", "mediaAssets", "compliance" ], "type": "object" }, "ProductVariationApiResult__Products-V5": { "properties": { "productVariations": { "items": { "$ref": "#/components/schemas/ProductVariation__Products-V5" }, "type": "array" }, "links": { "description": "a list of links that can be used for pagination.", "items": { "$ref": "#/components/schemas/Link__Products-V5" }, "type": "array" } }, "type": "object" }, "Sale__Products-V5": { "properties": { "salePrice": { "$ref": "#/components/schemas/MonetaryAmount__Products-V5" }, "startDate": { "description": "The start ISO8601 date for the sales.", "example": "2019-10-19T09:30:00Z", "format": "date-time", "type": "string" }, "endDate": { "description": "The end ISO8601 date for the sales.", "example": "2019-10-19T09:30:00Z", "format": "date-time", "type": "string" } }, "type": "object" }, "SkuPricing__Products-V5": { "properties": { "sku": { "description": "Partner-unique identifier for a product variation provided by the partner.", "type": "string" }, "standardPrice": { "$ref": "#/components/schemas/MonetaryAmount__Products-V5" }, "sale": { "$ref": "#/components/schemas/Sale__Products-V5" } }, "required": [ "sku", "standardPrice" ], "type": "object" }, "MaxOrderQuantity__Products-V5": { "description": "The maximum number of items a consumer may order during a specified time period. E.g. max 10 items every 7 days.", "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-V5": { "description": "A Container holding order constraints", "properties": { "maxOrderQuantity": { "$ref": "#/components/schemas/MaxOrderQuantity__Products-V5" } }, "type": "object" }, "ProductCompliance__Products-V5": { "description": "Compliance data must always be maintained. Must be used to provide information relevant for product compliance like e.g. addresses for product safety regulations. For the variations of a product, either the product safety container or the food/feed information container must be provided depending on the product category.", "properties": { "productSafety": { "$ref": "#/components/schemas/ProductSafety__Products-V5" }, "foodInformation": { "$ref": "#/components/schemas/FoodInformation__Products-V5" } }, "type": "object" }, "ProductSafetyAddress__Products-V5": { "description": "", "properties": { "name": { "description": "The company name of the manufacturer or the distributor. Maximum length: 100 characters.", "example": "Die Musterfirma GmbH", "type": "string" }, "address": { "description": "The complete address including street, postal code, city, country. Without any formatting, comma separation, no line breaks. Maximum length: 200 characters.", "example": "Musterstraße 1, 12345, Musterstadt, Deutschland", "type": "string" }, "regionCode": { "description": "Allowed values are all country codes in ISO-3166 Alpha-2 format. Important for validation of the address.", "example": "DE", "type": "string" }, "email": { "description": "A valid and complete email address. Maximum length: 100 characters. **Mandatory** if no URL is specified.", "example": "info@die-musterfirma.de", "type": "string" }, "url": { "description": "Valid URL to the contact information of the manufacturer or distributor (see http://www.ietf.org/rfc/rfc2396.txt and http://www.ietf.org/rfc/rfc2732.txt). Maximum length: 200 characters. **Mandatory** if no email is specified.", "example": "https://musterfirma/kontakt-information", "type": "string" }, "phone": { "description": "A valid phone number. Maximum length: 20 characters.", "example": "+ 49 40 123456789", "type": "string" }, "roles": { "description": "The role(s) of the economic agent to which the address belongs. Allowed values are 'DISTRIBUTOR' and 'MANUFACTURER'. At least one distributor must be specified.", "type": "array", "items": { "$ref": "#/components/schemas/ProductSafetyAddressRole__Products-V5" } }, "components": { "description": "Can be used in the case of set products for the correct assignment of addresses to set components, e.g. use components “mouse” and “keyboard” when selling a set of both.", "type": "array", "items": { "example": "mouse", "type": "string" } } }, "required": [ "name", "address", "roles" ], "type": "object" }, "ProductSafetyAddressRole__Products-V5": { "description": "The role of an address in the product safety context. Allowed values are 'MANUFACTURER' and 'DISTRIBUTOR'.", "enum": [ "MANUFACTURER", "DISTRIBUTOR" ], "example": "DISTRIBUTOR", "type": "string" }, "ProductSafety__Products-V5": { "description": "Should be used for providing information about the distributors and/or manufacturer of the product. https://account.otto.market/s/article/Verordnung-ueber-die-allgemeine-Produktsicherheit-EU", "properties": { "addresses": { "description": "The addresses of the distributors and/or manufacturer. If an address is maintained, name, address, email or url and roles are mandatory.", "type": "array", "items": { "$ref": "#/components/schemas/ProductSafetyAddress__Products-V5" } } }, "type": "object" }, "FoodInformationAddress__Products-V5": { "description": "", "properties": { "name": { "description": "The company name of the food or animal feed business operator. Maximum length: 100 characters.", "example": "Die Musterfirma GmbH", "type": "string" }, "address": { "description": "The complete address including street, postal code, city, country. Without any formatting, with comma separation, no line breaks. Maximum length: 200 characters.", "example": "Musterstraße 1, 12345, Musterstadt, Deutschland", "type": "string" }, "regionCode": { "description": "Allowed values are all country codes in ISO-3166 Alpha-2 format. Important for validation of the address.", "example": "DE", "type": "string" }, "email": { "description": "A valid and complete email address. Maximum length: 100 characters.", "example": "info@die-musterfirma.de", "type": "string" }, "url": { "description": "Valid URL to the contact information of the food or animal feed business operator (see http://www.ietf.org/rfc/rfc2396.txt and http://www.ietf.org/rfc/rfc2732.txt). Maximum length: 200 characters.", "example": "https://musterfirma/kontakt-information", "type": "string" }, "phone": { "description": "A valid phone number. Maximum length: 20 characters.", "example": "+ 49 40 123456789", "type": "string" }, "roles": { "description": "The role of the business operator to which the address belongs. Allowed values are 'FOOD_BUSINESS_OPERATOR' or 'FEED_BUSINESS_OPERATOR'. Every variation within a product must have the same role.", "type": "array", "items": { "$ref": "#/components/schemas/FoodInformationAddressRole__Products-V5" } }, "components": { "description": "Can be used in the case of set products for the correct assignment of addresses to set components, e.g. use components “Salad” and “Dressing” when selling a set of both.", "type": "array", "items": { "example": "Salad", "type": "string" } } }, "required": [ "name", "address", "roles" ], "type": "object" }, "FoodInformation__Products-V5": { "description": "Should be used for providing information about the food or animal feed business operator of the product. The affected assortment can be found in this article: https://account.otto.market/s/article/Weitere-Informationen-Sortimente-mit-besonderen-Anforderungen.", "properties": { "addresses": { "description": "The addresses of the food or animal feed business operator. If an address is maintained, name, address and roles are mandatory.", "type": "array", "items": { "$ref": "#/components/schemas/FoodInformationAddress__Products-V5" } } }, "type": "object" }, "FoodInformationAddressRole__Products-V5": { "description": "The role of an address in the food information context. Allowed values are 'FOOD_BUSINESS_OPERATOR' or 'FEED_BUSINESS_OPERATOR'.", "enum": [ "FOOD_BUSINESS_OPERATOR", "FEED_BUSINESS_OPERATOR" ], "example": "FOOD_BUSINESS_OPERATOR", "type": "string" }, "Address__Orders-V4": { "type": "object", "default": null, "description": "Address", "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 ISO-3166-1 Alpha-3 format", "example": "DEU" }, "email": { "type": "string", "description": "The e-mail address; if part of the delivery address is in plain text; 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" }, "zipCode": { "type": "string", "description": "The zipCode", "example": "12345" } }, "required": [ "city", "countryCode", "firstName", "houseNumber", "lastName", "salutation", "street", "zipCode" ], "title": "Address" }, "Amount__Orders-V4": { "type": "object", "default": null, "description": "Amount", "properties": { "amount": { "type": "number", "description": "The amount", "example": 15.99 }, "currency": { "type": "string", "description": "The currency in ISO_4217 format", "example": "EUR", "minLength": 1 } }, "required": [ "amount", "currency" ] }, "Dimension__Orders-V4": { "type": "object", "default": null, "description": "Dimension", "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", "default": null, "description": "InitialDeliveryFee", "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\"]" }, "default": null }, "vatRate": { "type": "number", "description": "The highest VAT rate of the products of all the position items", "example": 19 } }, "required": [ "deliveryFeeAmount", "name", "positionItemIds", "vatRate" ], "title": "InitialDeliveryFee" }, "InitialDiscount__Orders-V4": { "type": "object", "default": null, "description": "InitialDiscount", "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\"]" }, "default": null }, "vatRate": { "type": "number", "description": "The highest VAT rate between discounted products", "example": 19 } }, "required": [ "discountAmount", "discountId", "discountName", "name", "positionItemIds", "vatRate" ], "title": "InitialDiscount" }, "Link__Orders-V4": { "type": "object", "default": null, "description": "A link to various resources. A link can have different meanings and targets. The type of relation is specified with the property 'rel'.", "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", "default": null, "description": "OrderLifecycleInformation", "properties": { "lifecycleChangeDate": { "type": "string", "format": "date-time", "description": "The date, when this order has been placed" } }, "required": [ "lifecycleChangeDate" ], "title": "OrderLifecycleInformation" }, "PartnerOrder__Orders-V4": { "type": "object", "default": null, "properties": { "deliveryAddress": { "$ref": "#/components/schemas/Address__Orders-V4" }, "initialDeliveryFees": { "type": "array", "description": "The delivery fees on customer checkout", "items": { "$ref": "#/components/schemas/InitialDeliveryFee__Orders-V4" }, "default": null }, "initialDiscounts": { "type": "array", "description": "The initial discounts on customer checkout", "items": { "$ref": "#/components/schemas/InitialDiscount__Orders-V4" }, "default": null }, "invoiceAddress": { "$ref": "#/components/schemas/Address__Orders-V4" }, "lastModifiedDate": { "type": "string", "format": "date-time", "description": "Last order update date" }, "links": { "type": "array", "description": "Order related links like the link to fetch the single partner order", "items": { "$ref": "#/components/schemas/Link__Orders-V4" }, "default": null }, "orderDate": { "type": "string", "format": "date-time", "description": "The date, when this order has been placed" }, "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", "items": { "$ref": "#/components/schemas/PositionItem__Orders-V4" }, "default": null }, "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" }, "suspectedFraudCase": { "type": "boolean", "default": false, "description": "Order is suspected fraud case or not" } }, "required": [ "orderDate", "orderLifecycleInformation", "orderNumber", "positionItems", "salesOrderId" ], "title": "PartnerOrder" }, "PartnerOrderList__Orders-V4": { "type": "object", "default": null, "properties": { "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__Orders-V4" }, "default": null }, "resources": { "type": "array", "description": "The list of queried resources. In this case partner orders.", "items": { "$ref": "#/components/schemas/PartnerOrder__Orders-V4" }, "default": null } }, "title": "PartnerOrderList" }, "Payment__Orders-V4": { "type": "object", "default": null, "description": "Payment", "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\" (DEPRECATED), \"PAYPAL\", \"CREDIT_CARD\". These values are subject to change.", "example": "INVOICE_SINGLE" } }, "required": [ "paymentMethod" ], "title": "Payment" }, "PositionItem__Orders-V4": { "type": "object", "default": null, "description": "PositionItem", "properties": { "cancellationDate": { "type": "string", "format": "date-time", "description": "Date the position item was cancelled" }, "cancellationReason": { "type": "string", "description": "Reason why a position was cancelled", "enum": [ "CANCELLED_ON_CUSTOMER_WISH", "CANCELLED_ON_PARTNER_WISH", "PAYMENT_ABORTED", "PAYMENT_FRAUD", "PARTNER_TERMINATED", "ILLEGAL_PRODUCT", "MARKETPLACE_FRAUD", "CANCELLED_ON_MARKETPLACE_WISH" ] }, "dealId": { "type": "string", "description": "The unique id of the deal related to the position item", "example": "d36cbfd9-b7b9-44d5-96d3-052d6fd97a44" }, "dealName": { "type": "string", "description": "The name of the deal related to the position item", "example": "Deal der Woche 52" }, "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" ] }, "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" }, "product": { "$ref": "#/components/schemas/Product__Orders-V4" }, "returnAcceptedByMarketplace": { "type": "boolean", "default": false, "description": "Flag to indicate that the return has been accepted by the marketplace", "example": true }, "returnedDate": { "type": "string", "format": "date-time", "description": "Date the position item was returned" }, "sentDate": { "type": "string", "format": "date-time", "description": "Date the position item was sent" }, "trackingInfo": { "$ref": "#/components/schemas/TrackingInfo__Orders-V4" }, "weeePickup": { "type": "boolean", "default": false, "description": "Position item has electrical and electronic equipment disposal service (WEEE)" } }, "required": [ "fulfillmentStatus", "itemValueGrossPrice", "positionItemId", "product" ], "title": "PositionItem" }, "Product__Orders-V4": { "type": "object", "default": null, "description": "Product", "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", "items": { "$ref": "#/components/schemas/Dimension__Orders-V4" }, "default": null }, "ean": { "type": "string", "description": "EAN number of this product", "example": "233232323" }, "productTitle": { "type": "string", "description": "The title of this product", "example": "Black T-Shirt" }, "shopUrl": { "type": "string", "description": "Shop link for the product" }, "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", "default": null, "description": "TrackingInfo", "properties": { "carrier": { "type": "string", "description": "The name of the carrier", "example": "DHL" }, "carrierServiceCode": { "type": "string", "description": "The service code provided by the carrier" }, "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." }, "BadRequest__ReturnShipments-V1": { "description": "The server received invalid request regarding params, payload, pathVariable, Etc.", "type": "object", "properties": { "errors": { "$ref": "#/components/schemas/ErrorDescription__ReturnShipments-V1" } }, "example": { "errors": [ { "title": "BAD_REQUEST", "detail": "Parameter XYZ is invalid.", "path": "/return-shipments" } ] } }, "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." }, "MultiparcelCreateShipmentRequest__Shipments-V1": { "type": "object", "required": [ "shipDate", "shipFromAddress", "positionItems", "trackingKey" ], "properties": { "trackingKey": { "$ref": "#/components/schemas/MultiparcelTrackingKey__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/MultiparcelPositionItem__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": "MultiparcelCreateShipmentRequest" }, "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/MultiparcelCreateShipmentRequest__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" }, "returnAddressCarrierId": { "description": "Unique identifier for the return address and the return carrier combination. A returnAddressCarrierId is required when a partner has multiple return addresses/carriers. This identifier can be obtained through the ReturnsWarehouse API or in the Partner-Portal. Note that all position items within the same shipment must have the same returnAddressCarrierId.", "format": "uuid", "type": "string", "example": "7423afd2-e7ab-4bae-ac30-048b7c0346c1" } }, "title": "PositionItem" }, "MultiparcelPositionItem__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/MultiparcelReturnTrackingKey__Shipments-V1" }, "returnAddressCarrierId": { "description": "Unique identifier for the return address and the return carrier combination. A returnAddressCarrierId is required when a partner has multiple return addresses/carriers. This identifier can be obtained through the ReturnsWarehouse API or in the Partner-Portal. Note that all position items within the same shipment must have the same returnAddressCarrierId.", "format": "uuid", "type": "string", "example": "7423afd2-e7ab-4bae-ac30-048b7c0346c1" } }, "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", "ISSUE_OCCURRED" ] }, "occurredOn": { "type": "string", "example": "2022-05-01T07:49:12.642Z" } } }, "ReturnTrackingKey__Shipments-V1": { "description": "The return tracking key for the return process.