API documentation
Comprehensive Mailship API documentation: basics, authentication, product management, and e-commerce operations guide.
12 articles
Basic information
Mailship's API basics: authentication, token handling, endpoint info, rate limiting, data formats, and e-commerce operations.
Authentication + token handlingLearn how to authenticate with the Mailship API, handle token usage and refresh, and see PHP and Node.js examples for managing tokens.
Base informationExplore the API's basic information, inc. endpoint documentation, rate limiting, data formats, pagination, and sorting/filtering guidelines.
Organization, e-shop, warehouse and moreGuide to Mailship's API for managing e-commerce operations, including organization, e-shop, warehouse, and WMS information retrieval.
Products
Mailship's product management: creating, updating, deactivating, and listing products via API, with detailed request examples.
Creating ProductsLearn how to create products in Mailship using a POST request, including a detailed explanation of each field in the JSON payload.
Working with the productsDiscover how to retrieve, update, and deactivate products in Mailship using various API endpoints, complete with example requests.
Getting a List of Products in MailshipLearn to retrieve, sort, filter, and paginate product lists in Mailship via POST requests to API. Customize requests to suit your needs.
Stocks
Explore the Stocks section of the Mailship API documentation, featuring methods for stock synchronization and flexible data querying.
Loading ReceiptsLoading Receipts: A method for stock synchronization using the Mailship API to post stock movements, ensuring accurate inventory data.
Stock List APIStock List API allows flexible querying of data with filters, sorting, and selection of specific fields. Ideal for custom data retrieval.
Expeditions
Comprehensive guide on managing expeditions in Mailship, including creation, listing, rollback, and cancellation.
Create a expeditionGuide to creating, managing, and cancelling expeditions in Mailship. Detailed steps for efficient expedition handling.
Get list of ExpeditionComprehensive guide on how to retrieve a list of expeditions in Mailship using the Get list of Expedition endpoint with filtering options.
How to Use the Rollback Expedition EndpointGuide on reverting expeditions in Mailship before warehouse processing using the Rollback endpoint.
How to Use the Cancel Expedition EndpointGuide on cancelling expeditions in Mailship in ON-HOLD status using the Cancel endpoint.