Skip to main content

Orders API — v1 (Template)

Base URL: https://api.mimshackgroup.com/api/v1

🔐 Authentication​

  • Type: Bearer Token (Sanctum)
  • Header: Authorization: Bearer {token}

🛣️ Endpoints​

Create Order​

  • Method: POST
  • Path: /partner/orders
  • Payload: 
    {
      "pickup_address": "...",
      "delivery_address": "...",
      "items": []
    }

Get Order Status​

  • Method: GET
  • Path: /partner/orders/{id}

🪝 Webhooks​

  • Event: order.status.updated
  • Payload: 
    {
      "order_id": "123",
      "status": "DELIVERED"
    }

🚦 Rate Limits​

  • Standard: 100 req/min per IP.
  • Partner: 1000 req/min per API Key.