Base flow

Introduction

This guide is designed to assist you in integrating Mailship’s API. Whether you're managing product catalogs, monitoring inventory, or processing expeditions, our API provides a comprehensive set of endpoints to meet your needs.

Communication Format

Our API communicates using the JSON format. All requests require authentication via an API token. This documentation is structured to follow the essential steps necessary to successfully fulfill your expeditions.

Getting Started with Expedition Integration

Below is a summary of what is required to begin processing your expeditions. We recommend implementing endpoints that allow for the creation, listing and modification of products and expeditions. Detailed instructions for each step are available in the respective sections.

Expedition Fulfillment Process Flow

The following outlines the fundamental steps required to complete the final shipment of an expedition:

User Account & Authentication

The first step is to create a user account in Mailship. For this step, you need to contact our onboarding team or customer support.

To securely interact with Mailship's API, you must first set up authentication. This involves obtaining an API token, which is required for all subsequent API requests.

Product Catalog Setup

It is essential to establish a product catalog containing all items intended for shipment to customers. You need to implement methods for creating, updating and deleting products.

Inbound Stock Advice & Inventory Management

Once the product catalog is set up, you need to create stock advice. Stock advice enables us to physically stock your goods in our warehouse, making them available for expedition fulfillment. The inventory status of stocked goods can be monitored via Product Stock, which provides real-time data on:

• Available stock

• Reserved stock to expeditions

• Total stock in the warehouse

Expedition Creation & Processing

Once products, stock advice, and inventory tracking are fully implemented, you can begin creating expeditions. If you choose to integrate our API and submit expeditions via requests, it is essential to implement the relevant endpoints for expedition management (see the Expeditionsection for more details).

When an expedition is created, you must send the expedition for processing to WMS. The system verifies whether sufficient available stock is present for reservation. If the required stock is available and you intend for the expedition to be processed, it will receive the status "awaiting_processing" in Mailship, after which it can be dispatched to our Warehouse Management System (WMS) for fulfillment.

The WMS then handles expedition processing and hands it over to the designated carrier for delivery.

For a more detailed overview of the warehouse flow, such as the processes involved in receiving goods and fulfilling expeditions, please visit our Knowledge base.

Callbacks (webhooks)

If you are interested in setting up a new webhook, please contact our customer support and provide the following information: URL and event type.

You can receive updates via webhooks, which allows you to track real-time changes, such as:

• expedition status change

• expedition booked change

• product stock change

• product change

• stock advice status change

Expedition Tracking & Synchronization

All expedition updates, including tracking details and status changes, are synchronized with Mailship from our WMS, ensuring full visibility into expedition processing at all times.

Support

If you have any questions or need an assistance:

• Knowledge base - you can explore our help center for more articles and guides.

• Contact Support - reach out to our support team via email support@mailstep.cz.