REST API reference

Magento exposes different REST endpoints depending on the type of user making the requests. You must request and include a security token to gain access to the Customer and Admin REST API endpoints.

See Token-based authentication for instructions on requesting and using security tokens.

The list of Admin REST API endpoints contains a large number of endpoints and takes longer to load.

Synchronous endpoints

Each of the following links lead to a list of REST endpoints specific to a user type:

Asynchronous endpoints

You can run POST and PUT endpoints asynchronously while the async.operations.all message queue consumer is active. Asynchronous web endpoints provides information about asynchronous routes, payloads, and responses.