Rest API and Types

The METRO Markets REST API is an HTTP interface to the METRO Markets marketplace.

Via the METRO Markets API you can upload your product data, search through the different categories, upload and modify your offers, get the orders and change their status among other things.

Notes:

  • Please, send your requests to HTTPS endpoints (even if you see in the documentation any endpoints with http, use always HTTPS).
  • Depending on the action you would need to use GET, POST, PATCH, PUT, DELETE methods.
  • The language used is JSON , this means if a body is sent in the request it needs to be a valid JSON format AND the response is in JSON format.
  • Invoices and credit notes are handled in Order Management.
  • In offer and order we work with a X-Correlation-Id to identify the request. This X-Correlation-Id is a UUID number, which can help in case any troubleshooting or debugging is needed, so please save it to your logs. Here there are two possible options:
    • X-Correlation-Id is genereated by you, provided in the header of your requests and it’s also returned back in the header of our response.
    • X-Correlation-Id is genereated by Metro Markets and provided in the header of our response.

Types

Our METRO Markets APIs are separated into different business functionalities.

It´s recommended that you use all of them to avoid manual work and speed up processes.

All of them need authentication except Event Subscription.
Please, see Authentication for more information.

Service Category

This API will help you to allocate your products into their respective categories, check their specific attributes and any other information related to it.

Product Data

You can use this API to upload your product data and check the status of its validation process.

Offer Data

Upload, change and delete your offers using this API.

Order Management

Via this API you are be able see your orders, change their status, upload invoices and manage returns and cancellations.

Event Subscription

It allows your API to be notified on a change of status for your order, configuration or other notifications to help your system sync with ours.

Multimarkets / Crossborders

Use this API to get the available markets on METRO/MAKRO Markets and the possible cross-borders combinations between them.