Skip to main content
Version: 1.0.0

Volao API

The Volao REST API connects your store or system to Volao's shipping platform. With it you can quote shipments across several couriers, create and cancel orders, get each shipment's shipping label and track its journey, and manage your merchant's pickup addresses and clients.

What you can do​

AreaWhat it is for
AuthenticationGet an access token with your credentials.
OrdersCreate shipping orders, cancel them, get the shipping label, and check the tracking and incidents.
CouriersQuote a shipment and check the available couriers, their service modes, delivery promises, coverage, agencies and rates.
BranchesManage your merchant's pickup addresses and clients (recipients).
HistoryCheck the merchant's order, transaction and balance movement, settlement and benefit history.
Batch operationsCreate orders and generate shipping labels in bulk from an Excel file.
Catalogs and public dataDepartments, municipalities, address types, banks, document types, movement reasons and public order tracking.

Base URL​

Every path starts with /api and is appended to the server URL. For example: {server}/api/orders. You can see and choose the server in each endpoint's Request panel.

Authentication​

  1. Request your credentials (client_id and client_secret) from the Volao team.
  2. Get a token with POST /api/auth/client/login.
  3. Send the token in the header of every request: Authorization: Bearer <access_token>.

The token lasts 15 minutes and cannot be refreshed: when it expires, log in again. The endpoints under /api/open/ are public and do not require a token.

Request format​

  • Parameters of GET endpoints are sent in the URL (query string).
  • The body of POST, PUT, PATCH and DELETE requests is sent as JSON, with the header Content-Type: application/json.
  • The exception is the batch order upload, which receives the Excel file as multipart/form-data.

Response format​

Every response shares the same structure:

{
  "response_code": 200,
  "response_status": "Success",
  "response_message": "Operación exitosa",
  "data": {}
}

response_code repeats the HTTP status code and data contains the result. response_status may arrive as Success/Error or success/error, so compare it case-insensitively or use response_code.

The API responds in Spanish: response_message texts are shown in Spanish throughout this documentation.

Status codes​

CodeMeaning
200The operation was completed successfully.
201The resource was created successfully (for example, an order, an address or a client).
400The request has invalid data or is missing parameters.
401The credentials are invalid, or the token is missing, expired or invalid.
403The API client is disabled.
404The requested resource does not exist.
409The operation cannot be performed because of a business rule (for example, insufficient balance or a duplicate name). The reason comes in response_message.
500Internal server error.

Flow to create a shipment​

  1. Authenticate with POST /api/auth/client/login.
  2. Check the catalogs of departments and municipalities (/api/open/...) to get the location IDs.
  3. Choose or register the pickup address at /api/branchs/branchsAddresses.
  4. Choose or register the client (recipient) at /api/branchs/branchsClient.
  5. Quote the shipment with POST /api/courier to see the available couriers and their price.
  6. Create the order with POST /api/orders.
  7. Get the shipping label with GET /api/orders and track the shipment with GET /api/orders/tracking.

Try it from this documentation​

Each endpoint includes a panel to send real requests:

  1. Open API client login, enter your credentials and press Send API Request.
  2. Copy the access_token from the response.
  3. In any other endpoint, paste it in the panel's Auth field. It is kept until you close the tab.

More information​

Authentication​

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

JWT

Contact

Volao Team:

URL: https://volao.app