Menu

API Documentation

Our API is currently in beta. Features and endpoints may change as we continue to improve the service.

Introduction

The wallmarkets API allows you to programmatically access and manage your logistics data. You can create and track deliveries, process returns, manage products, and more.

Base URL

https://api.wallmarkets-logistics.com/v1

Response Format

All responses are returned in JSON format. Each response includes a status code and a data payload.

{
  "status": "success",
  "data": {
    // Response data here
  }
}

Authentication

To authenticate with the API, you need to include your API key in the request headers.

API Keys

You can generate API keys in your account settings. Keep your API keys secure and do not share them publicly.

Authentication Header

Authorization: Bearer YOUR_API_KEY

Example Request

curl -X GET \
  https://api.wallmarkets-logistics.com/v1/deliveries \
  -H 'Authorization: Bearer YOUR_API_KEY'

Rate Limits

To ensure the stability of our service, we apply rate limits to API requests.

Limits by Plan

Plan Rate Limit Burst Limit
Free 60 requests/hour 10 requests/minute
Pro 1,000 requests/hour 60 requests/minute
Business 10,000 requests/hour 300 requests/minute

Rate Limit Headers

Each response includes headers that indicate your current rate limit status:

  • X-RateLimit-Limit: The maximum number of requests you can make per hour
  • X-RateLimit-Remaining: The number of requests remaining in the current rate limit window
  • X-RateLimit-Reset: The time at which the current rate limit window resets (UTC epoch seconds)

Deliveries API

List Deliveries

GET /deliveries

Get a Delivery

GET /deliveries/{delivery_id}

Create a Delivery

POST /deliveries

Update a Delivery

PUT /deliveries/{delivery_id}

Delete a Delivery

DELETE /deliveries/{delivery_id}