Inventory API

The Inventory API is a high-throughput REST API used exclusively for uploading inventory data (e.g., vehicles, listings). Reading inventory data is not supported — please use the GraphQL API for data queries.

---

🔐 Authentication

• The API uses the same authentication mechanism as the GraphQL API.
• You must use an App Client Token with the inventory:write grant.
• User-level tokens are not supported.
• To get access, email support@vyro.co.

---

🚦 Rate Limits

• 10,000 requests per minute. All requests are processed asynchronously, typically within a few seconds.
• If you exceed the rate limit, you'll receive a 429 Too Many Requests response.

---

🌍 Environments

Environment	Endpoint
Production Asia-Pacific	https://inventory-api.vyro.com.au/v1/inventory
Production Europe	https://inventory-api.vyro-eu.com/v1/inventory
Staging	https://inventory-api.vyrolabs-staging.net/v1/inventory

---

📦 Endpoints

POST /batch

Upload a batch of inventory items (up to 100 items or 2MB).

Request Body

{
  "source_name": "demo-client",
  "items": [
    {
      "showroom_ids": ["1f3d9e2d-7c3c-4af3-b8e5-bb0c5b8a15fd"],
      "vehicle": {
        "source_id": "PS2-001",
        "production_year": "2024",
        "make": "Polestar",
        "model": "2",
        "condition": "new",
        "is_sold": false,
        "is_published": true,
        "is_listed": true,
        "estimated_delivery_delay": 14,
        "colour": "Snow",
        "interior": "Charcoal WeaveTech",
        "transmission": "Automatic",
        "odometer": 0,
        "pricing": {
          "type": "basic",
          "price": 6500000,
          "currency": "AUD"
        }
      },
      "location": {
        "name": "Sydney Showroom"
      },
      "assets": [
        {
          "type": "image",
          "placement": "featured",
          "order": 0,
          "src": "https://cdn.vyro.com/assets/ps2-featured.jpg"
        }
      ]
    }
  ]
}

Success Response

• 201 Created

{
  "job_id": "a2e456f3-89b2-4533-b4f2-3b92d8f4b9f3"
}

---

GET /jobs/{job_id}

Check the status of a previously submitted batch.

Path Parameters

• job_id (UUID): The ID of the batch job.

Success Response

• 200 OK

{
  "id": "a2e456f3-89b2-4533-b4f2-3b92d8f4b9f3",
  "status": "processing",
  "errors": []
}

---

📘 Notes

• Each inventory item should include vehicle, assets, and showroom_ids.
• Max 100 items per batch or 2MB of payload.
• moderate_images and moderate_content are optional, default to true.