Skip to content

oneConcepts API documentation#

Welcome to the oneConcepts API documentation! Amongst other things, our API allows you to update your current product-portfolio, place orders and receive tracking-information.

The URL of the API is https://api.1concepts.de/v2/. If you open the URL in your browser, you will be able to look at the swagger-documentation which includes descriptions of all endpoints and their models.

Besides the summarized section below you can look up in-depth details for all endpoints on their designated pages. You can reach them by using the horizontal navigation at the very top.

Light/Dark-Mode

You can use the button at the top to switch between light mode and dark mode

TL;DR#

This section contains a quick summary of the most important endpoints.

This allows developers (who are already familiar with our API) to have a glance at the core endpoints/specifications.

General#

  • The Content-type for all requests/responses is application/ld+json.
  • Responses will be paginated if the result is too long. The fields in the section hydra:view contain all information you may need for parsing paginated responses.
Attention

Even if the parameter itemsPerPage allows to alter the returned items per page, the amount should not be set above 200 in order to keep the performance steady.

Authentication (POST)#

All requests must be authorized via JSON Web Token that can be generated by posting your personal credentials to the endpoint api/create-token.

Products (GET)#

Requests on the endpoint api/products will return all relevant information for each product, including:

  • Category-reference-links (so products can be sorted into their categories by doing a request on api/categorytree).
  • Prices (namely netCost and rrp).
  • Translations.
  • Shipping-Costs are country-specific and can be accessed through the endpoint api/shippings.
  • Available countries.

Product Availability (POST)#

Requests on the endpoint api/products/check-availability allow you to let the API detect EOL items for you.

Orders (GET, PATCH, POST)#

Orders have to be posted with at least the following values:

  • Your personal partner-id in the field partner.
  • Your order number in the field externalOrderNumber.
  • The sku for each product.
  • netCost for each product.
  • Mandatory address-details.

Stocks (GET)#

Available stocks can be retrieved from api/stocks.

Hint

Stock-values are updated every hour.

Trackings (GET)#

Tracking will be available through the endpoint api/trackings or by checking the linked list trackings in the order-resource.