OTTO Market API documentation



Product interfaces

The 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.

The API offers endpoints for different aspects of product data management:

  • The "Products" endpoint can be used to send the products to the OTTO Market. The POST operation will return a state (like 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", also specialized into "succeeded" and "failed"). 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 products in one request, so the processing could take some time, therefore we only offer an asynchronous access to the received produdc 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 "Product Online 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.

  • The "Brands" endpoint gives you all the brands OTTO Market knows and can reference, so you should use this endpoint to make the brand names in your products fit to OTTO Market brands and their exact names.

  • 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.

Example

A typical sequence dealing with our interfaces would be: 1. You query the Brands interface and match the brand names in Your products to the names in the received brands. 2. You query the Categories interface and match the category names in Your products to the names in the received categories. 3. You use the POST endpoints from the Products interface to send Your products to Otto Market 4. You will receive 202 HTTP return code and a body like: { "state": "pending", "message": "The process is currently in progress", "progress": 0, "total": 2, "pingAfter": "2019-09-02T17:22:59.8686821+02:00", "links": [ { "rel": "self", "href": "/v1/products/update-tasks/09abe6ca-9c36-45bb-9cd3-a7de7f93284b" }, { "rel": "failed", "href": "/v1/products/update-tasks/09abe6ca-9c36-45bb-9cd3-a7de7f93284b/failed" }, { "rel": "succeeded", "href": "/v1/products/update-tasks/09abe6ca-9c36-45bb-9cd3-a7de7f93284b/succeeded" } ] } 5. You execute /v1/products/update-tasks/09abe6ca-9c36-45bb-9cd3-a7de7f93284b until the state changes to "succeeded" or "failed". Usually this will happen very fast. 6. You execute /v1/products/update-tasks/09abe6ca-9c36-45bb-9cd3-a7de7f93284b/succeeded and /v1/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).

Authentication

All interfaces expect the consumer to add a valid JWT token to the request, otherwise the request will fail with HTTP 401 or 403

Changelog

This changelog will document all relevant changes in our interface.
Kudos to https://keepachangelog.com/de/1.0.0/

Status: Released

2019-09-03

Changed

  • eliminated filename from mediaasset
  • explained the usage of limiting requests

2019-09-03

Changed

  • added introduction to the API
  • added examples to the models

2019-08-21

Changed

  • corrected documentation for Pricing container
  • removed PartnerProduct container from Product api, ProductVariation is top level container for GET and POST of products
  • Attribute has to be delivered with a value list instead of single value

2019-08-13

Changed

  • renamed endpoint v1/products/known-brands to v1/products/brands

2019-07-31

Added

  • Very first draft of the description for the product import API. API itself is not live yet!

Changed

  • nothing

Removed

  • nothing

Deprecated

  • nothing

2019-07-25

Added

  • Query for known product brands

You may now query the list of brands known to the market place. The list will be sorted alphabetically (taking german umlauts into account). The list is not paged.

  • Query for product categories

You may now query for the list of categories that may be used for classifying your products. The list is paged and you can propose a maximum page length by using the limit parameter.

Changed

  • Product variation online status API

Now the modification request response body contains a JSON that describes the modification procress including a progress indication and a link that could be used to regularly ping for the current modification process progress (see ProductProcessProgress).

Removed

  • nothing

Deprecated

  • nothing

2019-06-19

Added

  • Product variation online status API

Changed

  • Documentation of hello world endpoint

Removed

  • nothing

Deprecated

  • nothing
Imprint | Privacy policy | Datenschutz