API Documentation

Complete reference for the eveXso REST API. 72+ endpoints across 12 entity types.

Try API Playground

Overview

Base URL

https://api.evexso.com/v1

Production environment

Authentication

Bearer {token}

OAuth 2.0 client credentials

Format

application/json

All requests and responses

Authentication Example

First, obtain an access token using your client credentials:

POST /oauth/token
Content-Type: application/json

{
  "client_id": "your_client_id",
  "client_secret": "your_client_secret",
  "grant_type": "client_credentials"
}

Response:
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 86400
}

Then include the token in all subsequent requests:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

API Endpoints

Authentication

OAuth 2.0 authentication for API access

POST
/oauth/token

Exchange client credentials for access token (valid 24 hours)

Inventory Management

Manage inventory items, stocking factors, and warehouse information

POST
/inventory/add

Add or update inventory items (bulk up to 1000 items)

POST
/inventory/check

Retrieve current inventory items

POST
/inventory_stocking_factor/add

Set min/max stocking levels per warehouse

POST
/inventory_warehouse_info/add

Set warehouse-specific item details

POST
/inventory_dangerous_goods/add

Set dangerous goods classifications

Sales Orders

Import and manage sales orders

POST
/sales_order/add

Import sales orders with line items

POST
/sales_order/check

Retrieve sales order status

Purchase Orders

Import purchase orders and manage receipts

POST
/purchase_order/add

Import purchase orders

POST
/purchase_order/check

Retrieve purchase order status

Customers

Manage customer records and delivery locations

POST
/customer/add

Add or update customer records

POST
/customer/check

Retrieve customer records

POST
/supply_location/add

Add customer delivery locations

POST
/supply_location/check

Retrieve supply locations

Suppliers

Manage supplier records and locations

POST
/supplier/add

Add or update supplier records

POST
/supplier/check

Retrieve supplier records

Warehouse Structure

Manage warehouse locations and bin structure

POST
/warehouse/add

Create or update warehouses

POST
/warehouse/check

Retrieve warehouse structure

POST
/area/add

Create warehouse areas

POST
/zone/add

Create warehouse zones

POST
/bin/add

Create storage bins

ERP Updates

Poll for shipments, receipts, and inventory movements

POST
/erp_update/outgoing_consignment

Retrieve completed shipments

POST
/erp_update/incoming_consignment

Retrieve completed receipts

POST
/erp_update/move_attempt

Retrieve inventory movements

POST
/erp_update/set_complete

Mark ERP update as processed

POST
/erp_update/set_error

Mark ERP update as failed with error details

Inventory Reconciliation

Reconcile inventory between ERP and eveXso

POST
/comparison/add

Create a new inventory comparison

POST
/comparison_erp_on_hand/add

Add ERP inventory quantities

POST
/comparison_evexso_on_hand/set

Set eveXso inventory quantities

POST
/comparison_adjustment_item/add

Add adjustment items for discrepancies

POST
/comparison_item/process

Process comparison items

POST
/comparison_move_attempt/create

Create move attempts for adjustments

POST
/comparison/complete

Complete the inventory comparison

POST
/comparison/check_status

Check comparison status

Courier Services

Manage courier integrations and tracking

POST
/courier_service/add

Add or update courier services

POST
/courier_service/check

Retrieve available courier services

Production Orders

Manage manufacturing and assembly operations

POST
/production_order/add

Import production orders

POST
/production_order/check

Retrieve production order status

Dangerous Goods

Manage dangerous goods classifications

POST
/dangerous_goods_lookup/add

Add UN number classifications

POST
/dangerous_goods_lookup/check

Retrieve dangerous goods lookups

Ready to Start Building?

Get API credentials and start integrating today.

Dave from eveXso