API Documentation and Endpoints
The complete API documentation, including all available endpoints, can be found at https://app.mailship.eu/api/doc. However, please note that this documentation is comprehensive and you may not need to use all the endpoints listed there for your integration.
The base URL for making API calls in the production environment is https://app.mailship.eu/api/.
If you're testing your integration, you can use our staging environment. The base URL for the staging environment is https://staging.mailship.eu/api/.
Remember to replace the base URL in your API calls depending on whether you're working in the production or staging environment.
Rate Limiting
The Mailship API has a rate limit of 25 requests per second. If you exceed this limit, your requests will be throttled and you may receive an error response.
Data Formats
The Mailship API uses JSON for both request and response data. Make sure to set the Content-Type header to application/json when sending requests.
Pagination
The Mailship API supports pagination in its responses. Here's an example of what the pagination information might look like:
"paging": {
"returned": 10,
"from": 5,
"to": 15,
"total": 30
}In this example, returned is the number of items returned in the current response, from and to specify the range of items returned, and total is the total number of items available.
Sorting and Filtering
You can sort and filter the results returned by the Mailship API using the criteria, sort, limit, offset, select, and nested parameters in your requests. Here's an example:
{
"criteria": {
"id": {},
"productSku": {},
// ...
"productGroup.name": {}
},
"extra": {
"partiallyDelivered": true
},
"sort": [
{}
],
"limit": 100,
"offset": 200,
"select": [
"id",
"eshops",
"productSku",
// ...
"changedAt"
],
"nested": true
}
In this example, criteria specifies the fields you want to filter by, extra specifies additional filters, sort specifies the fields you want to sort by, limit specifies the maximum number of items to return, offset specifies the number of items to skip before starting to return items, select specifies the fields you want to include in the response, and nested specifies whether to include nested fields.