Skip to main content

Overview

The OrderMonk API gives you programmatic access to your e-commerce data. Use it to build custom integrations, automate workflows, and extend OrderMonk’s capabilities.

Base URL

All API requests are made to:
https://api.ordermonk.com/v1

Authentication

All requests require authentication via API key. See Authentication for details.
curl -X GET https://api.ordermonk.com/v1/products \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Rate Limits

PlanRequests per minuteRequests per day
Starter6010,000
Growth12050,000
Enterprise300Unlimited
Rate limit headers are included in every response:
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 55
X-RateLimit-Reset: 1704067200

Response Format

All responses use JSON format with consistent structure:

Successful Response

{
  "success": true,
  "data": {
    "id": "prod_abc123",
    "name": "Example Product",
    "sku": "SKU-001"
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The 'sku' field is required.",
    "details": []
  }
}

HTTP Status Codes

CodeDescription
200Success
201Created
400Bad Request — Invalid parameters
401Unauthorized — Missing or invalid API key
403Forbidden — Insufficient permissions
404Not Found — Resource doesn’t exist
429Too Many Requests — Rate limit exceeded
500Internal Server Error

Available Endpoints

Products

  • GET /v1/products — List all products
  • GET /v1/products/:id — Get a product
  • POST /v1/products — Create a product
  • PUT /v1/products/:id — Update a product
  • DELETE /v1/products/:id — Delete a product

Inventory

  • GET /v1/inventory — List inventory levels
  • GET /v1/inventory/:sku — Get inventory for a SKU
  • PUT /v1/inventory/:sku — Update inventory level
  • POST /v1/inventory/bulk — Bulk update inventory

Orders

  • GET /v1/orders — List all orders
  • GET /v1/orders/:id — Get an order
  • GET /v1/orders/stats — Order statistics

Keywords

  • GET /v1/keywords/suggestions — Get keyword suggestions
  • GET /v1/keywords/outcomes — Get outcome statistics
  • POST /v1/keywords/research — Run keyword research

SDKs & Libraries

Official SDKs are coming soon. In the meantime, use any HTTP client to interact with the API.

Need Help?