Welcome to our API library, with a growing suite of self service API's

Discover more on our API's and how they can be used in your business. 

Printbles
USE CASE 1

Analyse and monitor live transactions directly from your own BI Tools

USE CASE 2

Seamlessly integrate ShipServ Trade into your own system

ORDER MANAGEMENT API OVERVIEW

order-management-api-icon.png Integrate Trade into your system with the Order Management API

Order Management For Buyers & Suppliers

The Order Management API allows Buyers and Suppliers to send and receive transaction documents from Request for Quotes to Purchase Order Confirmations directly from their systems. It is a simple and secure way to connect and integrate the flow of trading documents.

ORDER MANAGEMENT API FOR BUYERS

As a Buyer, you will be able to perform the following activities directly from your system:

  • Send and Import Requisitions.
  • Send Request for Quotes to your suppliers.
  • Receive supplier Quotation response.
  • Send Purchase Orders to your suppliers.
  • Receive Purchase Order confirmations from your suppliers.
  • Send and Receive document acknowledgment status.
ORDER MANAGEMENT API FOR SUPLIERS

As a Supplier, you will be able to perform the following activities directly from your system:

  • Receive Request for Quotes from your buyers.
  • Send a Quotation response to your buyers.
  • Receive Purchase Orders from your buyers.
  • Send Purchase Order confirmations to your buyers.
  • Send and Receive document acknowledgment status.
ORDER MANAGEMENT API USE CASE

Use Case Example:

The Order Management API is a simple and secure way for Buyers and Suppliers to connect and integrate the flow of trading documents directly from their own systems. This means that all the core Trade Platform activities can be performed seamlessly from within your own preferred ERP platform, providing the Trade Platform functionality but within the familiar UX of your standard management systems.

Seamless ERP Integration

Integrate the benefits of a global procurement platform into your existing ERP / Management system. Enjoy the benefits of a centralised view of your full business activities as well as consolidated reporting.

Single Platform Experience

By integrating Trade Platform features into your own familiar ERP User Interface, you are removing the need for your users to learn a secondary platform. This not only speeds up procurement adoption but also minimises risk from error.

ORDER MANAGEMENT API - GET STARTED

Tutorials and Documentation

ShipServ API Quick Start

Get Started with the Order Management API Here are a few ideas for getting started with the Order Management API

Order Management API Reference

MicrosoftTeams-image (6)
INVOICING API OVERVIEW

invoicing-api-icon.pngSend and receive invoices and documentation between buyers and suppliers with the Invoice API

Send & Receive Invoices 

ShipServ's Invoicing APIs allows Suppliers and Buyers to send and receive invoices, credit-notes and supporting documents electronically between systems.

INVOICING API FOR BUYERS

As a Buyer, you will be able to perform the following activities directly from your system:

  • Get the list of new invoices and credit-notes
  • Import all new invoices, credit-notes and supporting documents into your invoicing system.
  • Mark a document as exported which will serve as an acknowledgment to your suppliers.
  • Basic Filtering & Sorting - retrieve paged list, filter by header information such as reference number, PO number, Supplier, vessel IMO and more.

INVOICING API FOR SUPLIERS

As a Supplier, you will be able to perform the following activities:

  • If you have an integration with ShipServ, you will be able to send invoices, credit-notes and related documents directly from your system.
  • If you do not have an integration with ShipServ, you will still be able to upload and send the invoices, credit-notes and supporting documents in ShipServ's Trade Platform.
  • Receive a "READ" status, which will serve as an acknowledgment response from your buyer.
INVOICING API USE CASE

Use Case Example: 

Improve visibility over, and the turnaround time of invoices, by using the Invoice API that ensures simplified and centralised processing that helps to get you paid qiuicker. There are many positives for both the buyer and the supplier, when they collaborate with the invoicing API. For example a reduction in the complexity of receiving and processing an invoice, due to the fact that it is sent and received directly from the platform into your own invoice system, with minimal touch points.

Improved Visibility & Reporting

By tying the invoice to the trade process, you align the transaction flow together which in turn gives you improved visibility over both. You are able to filter and view invoices as well as check on the status.

Get Paid Quicker & Improve Cash Flow Forecasting

Direct, centralised invoicing speeds up the process. By removing the manual process of sending an invoice to your buyer's finance team, where your invoice is one of hundreds, and instead choosing to send via the API, you will receive a 'Read' notification once the buyer has opened it so you know that the payment process has begun. The process of tying the invoice to the transaction also enables the finance team to approve the invoice much quicker. And with all your invoices, and invoice statuses in one place, forecasting revenues becomes much simpler.

Reduce Errors and Transaction Costs

Remove the potential for human error that creates friction in the invoicing process, as well as time delays to payment. It is estimated that automated invoicing can reduce time spent on admin by as much as 20 hours a week. In addition, manually processing invoices is a huge unseen labour cost, which can be reduced by automation.

INVOICING API - GET STARTED

Tutorials and Documentation

ShipServ API Quick Start 

Get Started with the Invoicing API Here are a few ideas for getting started with the Invoicing API

Invoicing API Reference 

API-Image-InvoicingV2
CONTROL TOWER API

invoicing-api-icon.pngEnjoy a real time helicopter view across your transactions with the Control Tower API

CONTROL TOWER API FOR BUYERS & SUPLIERS

As a Buyer or a Supplier, you will be able to perform the following activities directly from your system:

  • Get a list of Documents (paged)
  • Get real time status updates of your documents
  • Get all linked documents
  • Search for details based on partial or exact match
  • Sort details
  • Get counts of documents
  • Use advanced filtering option to narrow down the results based on the following criteria: By date range, Based on amounts, Status, Document Type
CONTROL TOWER API OVERVIEW

Real Time View Across Transactions 

ShipServ's Monitoring API gives Buyers and Suppliers a simple way to get real time status updates on your documents with advanced filtering options, directly to your system or incorporate the data in your third-party reporting tools

CONTROL TOWER API USE CASE

Use Case Example: 

The Control Tower API is perfect for gaining quick real time insight into the status of your trade transactions. With built in filtering options you can quickly export reports and insights to enable you to make informed decisions.

Performance Reporting

Run real time reports at set intervals in order to compare performance across time periods. Reports can be created using the filters within Control Tower, or by exporting the data and incorporating into your own BI systems.

Management Dashboards

Easily create Management Dashboards that are fed by real time information from Control Tower to understand the status of all of your transactions. Streamline your business processes with a real time helicopter view of your trade process.

Ad-hoc Data Search

Control Tower API is a single location where you can search and extract real time itemised data sets on demand, to fulfil information requests. For example, search for details based on exact match or partial match, including date, amounts, status and document type.

Predictive Troubleshooting

Use the real time data within Control Tower to understand your trade flows and process bottlenecks. This way you are able to flag and deal with potential problems before they become a customer issue. Compare historical data against real time data to better manage and streamline your processes.

CONTROL TOWER API - GET STARTED

Tutorials and Documentation

ShipServ API Quick Start 

Get Started with the Control Tower API Here are a few ideas for getting started with the Control Tower API

Control Tower API Reference Here are a few ideas for getting started with the Control Tower API

Ask questions by emailing support@shipserv.com

API-Image-ControlTower