Describes what the ShipServ APIs are and its capabilities
APIs (Application Programming Interface) is a set of web services that enables different capabilities to client systems for Order Management, Invoicing and Transaction monitoring.
APIs Available
Enables buyers and suppliers to send and receive transaction documents from Request for Quotes to Purchase Order Confirmations directly from their systems.
Invoicing API
Enables buyers to access, download Invoices and Credit Notes sent by suppliers directly into their invoice system.
Control Tower API
Enables buyers and suppliers to get real-time information on their order management and invoice transaction status.
Getting started
The best place to get started with the ShipServ APIs is the API Quickstart guide.
Authentication
Our APIs uses OAuth 2.0 which uses security tokens for authentication and authorization.
Security tokens are generated using a Client ID and Secret.
To get your Client ID and secret please contact us at support@shipserv.com
Endpoints
The API endpoints can be found in each of the API documentations.
Response Codes
Each API call returns an HTTP status code that reflects the nature of the response.
Here is the List of API response codes and what can be done to Troubleshoot in case of an error.
-
200 OK
The request has succeeded.
-
400 ERR_BAD_REQUEST
Check the URL/Network Connection/Data sent. If still not resolved contact support@shipserv.com
-
400 ERR_MISSING_SUBSCRIPTION
Subscription needed to access/use the API. Contact your ShipServ admin or send an email to support@shipserv.com for further assistance.
-
401 ERR_AUTH_TOKEN_INVALID
Check the token used. Generate a new token and call the operation.
-
404 ERR_DOC_NOT_FOUND
Check the document id passed in the query.
-
405 ERR_METHOD_NOT_SUPPORTED
Check the URL or the Operation method used for the API call.
-
500 ERR_INTERNAL_SERVER_ERROR
Retry after some time. If still not successful, contact support@shipserv.com