Skip to content

Inventory API Integration

If you have an inventory management system that can send data automatically, you can use our API to keep your Voxum inventory in sync.

Note

This section contains technical information. You may need to share it with your IT team or developer.

When to Use API Integration

Use API integration when:

  • Your inventory changes frequently (daily or more)
  • You have a system that can send HTTP requests
  • You want automated updates without manual file uploads
  • You manage a large inventory

For occasional updates, file upload may be simpler.

API Overview

Voxum supports two data formats for inventory integration:

  • JSON - JavaScript Object Notation
  • XML - Extensible Markup Language

Both accomplish the same thing—choose whichever your system supports.

Finding Your API Information

  1. Go to Inventory in the left menu
  2. Scroll to the API Integration section
  3. You'll find:
  4. Your API endpoint URL
  5. Your property ID
  6. Example request format

API information

API Authentication

Your API requests must include your API key for authentication.

Getting an API Key

  1. Go to API Keys in the left menu
  2. Click Create API Key
  3. Give it a name (e.g., "Inventory Integration")
  4. Copy and securely store the key

Learn more about API keys →

Including the API Key

Add your API key in the request header:

X-API-Key: your-api-key-here

JSON Format

Endpoint

POST https://app.voxum.ai/api/inventory

Request Headers

Content-Type: application/json
X-API-Key: your-api-key-here

Example JSON Payload

{
  "items": [
    {
      "id": "SKU001",
      "name": "2024 Honda Accord",
      "category": "Sedan",
      "price": 32500,
      "description": "Brand new sedan with advanced safety features",
      "attributes": {
        "year": "2024",
        "make": "Honda",
        "model": "Accord",
        "color": "White",
        "mileage": 0
      },
      "available": true,
      "url": "https://yoursite.com/vehicles/sku001",
      "image": "https://yoursite.com/images/accord.jpg"
    },
    {
      "id": "SKU002",
      "name": "2023 Toyota RAV4",
      "category": "SUV",
      "price": 29800,
      "description": "Popular SUV with excellent reliability",
      "attributes": {
        "year": "2023",
        "make": "Toyota",
        "model": "RAV4",
        "color": "Blue",
        "mileage": 15000
      },
      "available": true,
      "url": "https://yoursite.com/vehicles/sku002"
    }
  ]
}

JSON Field Reference

Field Type Required Description
id string Yes Unique identifier
name string Yes Display name
category string No Category or type
price number No Price (no currency symbol)
description string No Item description
attributes object No Custom key-value pairs
available boolean No In stock or available
url string No Link to detail page
image string No Image URL

XML Format

Endpoint

POST https://app.voxum.ai/api/inventory

Request Headers

Content-Type: application/xml
X-API-Key: your-api-key-here

Example XML Payload

<?xml version="1.0" encoding="UTF-8"?>
<inventory>
  <item>
    <id>SKU001</id>
    <name>2024 Honda Accord</name>
    <category>Sedan</category>
    <price>32500</price>
    <description>Brand new sedan with advanced safety features</description>
    <attributes>
      <year>2024</year>
      <make>Honda</make>
      <model>Accord</model>
      <color>White</color>
      <mileage>0</mileage>
    </attributes>
    <available>true</available>
    <url>https://yoursite.com/vehicles/sku001</url>
    <image>https://yoursite.com/images/accord.jpg</image>
  </item>
  <item>
    <id>SKU002</id>
    <name>2023 Toyota RAV4</name>
    <category>SUV</category>
    <price>29800</price>
    <description>Popular SUV with excellent reliability</description>
    <attributes>
      <year>2023</year>
      <make>Toyota</make>
      <model>RAV4</model>
      <color>Blue</color>
      <mileage>15000</mileage>
    </attributes>
    <available>true</available>
    <url>https://yoursite.com/vehicles/sku002</url>
  </item>
</inventory>

Response Codes

Code Meaning
200 Success - inventory updated
400 Bad request - check your data format
401 Unauthorized - check your API key
413 Payload too large - reduce batch size
500 Server error - try again later

Best Practices

Batch Updates

  • Send complete inventory in each request
  • Don't send individual items one at a time
  • Maximum recommended batch: 10,000 items

Update Frequency

  • Real-time not required for most use cases
  • Hourly or daily updates usually sufficient
  • More frequent updates increase server load

Error Handling

  • Log API responses for troubleshooting
  • Implement retry logic for failures
  • Alert on repeated failures

Data Quality

  • Validate data before sending
  • Ensure prices are numbers
  • Verify URLs are accessible

Testing Your Integration

  1. Create a test API key
  2. Send a small batch (5-10 items)
  3. Check the response
  4. Test your chatbot with inventory questions
  5. Scale up once confirmed working

Getting Help

If you need help with API integration:

  1. Review the examples above
  2. Check response codes for error hints
  3. Verify your API key is active
  4. Contact support with specific error messages

Next Steps