Qodex.ai

Drayup Web API Reference

Number of APIs: 19

Scope

The Drayup API is designed to streamline booking processes, enhance the functionality of third party applications and improve the overall user experience of these applications.

This API provides efficient booking management, comprehensive yard location and equipment information, and access to booking invoices. Developers can therefore provide a more efficient user experience for their applications by optimizing their booking processes using this documentation.

Getting Started

In order to take full advantage of the Drayup API, users must follow these essential steps:

Account Creation

Start by creating an account through drayup.com. This account will serve as your gateway to access the features and functionality of the API.

Access Token

After creating your account, you will need to obtain an access token. This token acts as a secure key that grants your application permission to interact with the API. Detailed instructions on how to obtain and manage access tokens can be found in our API Settings section.

Payment Information

To facilitate seamless booking and payment processes, you must add your credit card information from the My Account page. This will ensure that you can successfully complete transactions and take full advantage of our services.

By following these steps, you'll be well prepared to integrate the Drayup API into your application and make the most of its capabilities.

API Settings

  • Log in to account.
  • Click your profile name or avatar in the upper right corner of the Home page, and then click the Authentication menu to access the authentication settings.
  • Click the Generate an API Key button.
  • If a new API key is required for security or other reasons, click the Regenerate button to generate a new one.

  1. Invoices - Get invoice list GET {{baseUrl}}/invoices

  2. Equipments - Get equipment by code GET {{baseUrl}}/equipments/:equipmentCode

  3. Equipments - Get equipment status list GET {{baseUrl}}/equipments/statuses

  4. Locations - Get equipments by location key GET {{baseUrl}}/locations/:locationKey/equipments

  5. Locations - Get location list GET {{baseUrl}}/locations

  6. Bookings - Cancel booking by booking code PATCH {{baseUrl}}/bookings/:bookingCode/cancel

  7. Yards - Get yard list GET {{baseUrl}}/yards

  8. Profile - Get payment method list GET {{baseUrl}}/profiles/payment-methods

  9. Bookings - Get booking list GET {{baseUrl}}/bookings

  10. Bookings - Get booking by code GET {{baseUrl}}/bookings/:bookingCode