TABLE OF CONTENTS
- 1 Introduction
- 2 Overall Description
Last change : 01.01.2022
This document is a specification for web service API integration for external clients. The web service API provides methods for creating shipments, printing labels, tracking and get static data.
To get technical support for the integration please send us an e-mail to email@example.com and provide the following info:
- Error context (if relevant)
- Error message (if relevant)
- and detailed explanation of the situation you need support for.
This document specifies Web Service API used to connect external customers to the core system functionality to create, print or track shipments and parcels, using available courier services with their limitations, additional services and options.
1.2 Terms And Conditions
Date data types referred in this document that contains actual dates (without time) should be passed as “yyyy-MM-dd” formatted string in the request. Date responses are in the same format.
Date data types referred in this document as datetime should be passed as “yyyy-MM-ddTHH:mm:ssZ” formatted string in the request. Datetime responses are in the same format.
In JSON fields boolean values allowed are only “true/false”.
Response data structures may be changed in the future adding additional fields. Therefore, client applications should be able to accept unknown fields in responses for backward compatibility
The document specifies communication protocol for integration, which is request/response based over HTTP Secure.
The web service API requires an API key authentication for each method.
Swagger Documentation : https://api.innoship.com
2 Overall Description
This has to be included for all requests from this document.
|X-Api-Key||True||apikey provided by Innoship|
|api-version||True||Current version is 1.0. so header should be: api-version=1.0|
2.2 Test credentials
Contact Sales: firstname.lastname@example.org