Quick Start Guide

Follow the steps below to integrate Merchrocket's API into your applications.

Create Acount

To get started with Merchrocket, the first step is to create an account on our platform. Creating an account is essential in order to access the full range of features and services we offer. When you sign up, you get access to a personalised dashboard where you can manage your products, orders and settings.

Get API Access

Once you are registered, navigate to the API settings in your account dashboard. Generate API keys following the instructions provided. Each API key acts as a unique identifier for your application.

Ensure secure access to Merchrocket's resources by authenticating your API requests with the generated API key. For more details on authentication, please refer to the Authentication Guide.

Test Environment

Before starting the integration, we recommend that you thoroughly test your application in our test environment to ensure compatibility and functionality with the Merchrocket API. Detailed instructions can be found in the Testing Guide.

Create Orders

Explore the available order API endpoints and create your order requests with the required information such as product details, variants, quantities and shipping addresses. For detailed instructions on creating orders, please refer to the API Reference and the example.

Track Order Status

Learn more about the Order API endpoints to get more information about the current status of your order. These endpoints provide more information about fulfilment, shipping and any issues that may have occurred. Also familiarise yourself with our order workflow to better understand the various order status changes.

Use Webhooks

Consider setting up webhooks to receive real-time notifications of order changes. You can configure your webhook URL in your Merchrocket account settings. Once set up, Merchrocket will send POST requests to the URL you specify whenever the status of your orders changes. For more information on setting up webhooks, please see the Webhooks Guide.

Error Handling

Ensure the smooth processing of your API requests by implementing robust error handling mechanisms in your application. Detailed error handling guidelines and best practices can be found in the Error Handling Guide.

Consult API Documentation

The official Merchrocket API documentation is regularly updated with comprehensive instructions and references. The documentation includes explanations of the available endpoints, request parameters, response formats, authentication methods and best practices for integration.

With these steps and the examples provided, you can quickly start integrating the Merchrocket API into your applications and streamline your e-commerce operations.