interlinkflow

{
  "swagger": "2.0",
  "info": {
    "title": "Interlink Express API",
    "description": "API Documentation Shipping Interlink Express",
    "version": "1.0.0"
  },
  "host": "api.interlinkexpress.com",
  "schemes": [
    "https"
  ],
  "basePath": "/",
  "produces": [
    "application/json"
  ],
  "securityDefinitions": {
    "Authorization": {
      "type": "basic"
    },
    "GeoSession": {
      "type": "apiKey",
      "in": "header",
      "name": "GeoSession"
    }
  },
  "security": [],
  "paths": {
    "/user": {
      "post": {
        "summary": "Login API.",
        "description": "The Login API is different to all other APIs as it returns a GeoSession. The other APIs require the GeoSession to be passed in as a security validation. Calling this API also sets up a session on the Interlink servers. This server session allows all future interactions to be validated without the need to present login credentials. The API requires the username and password to be encrypted using base64 encryption and then passed as an Authorization header in the HTTP request,\n\nExample\n\nusername = DSmith\n\n\npassword = MYPassWd66\n\nConcatenate the username and password with a colon in between and encrypt to base64 as a single string:\n\ne.g: DSmith:MYPassWd66\n\nThis would result in a string of: RFNtaXRoOk1ZUGFzc1dkNjY=\n\nThis can be applied to the http request as a header of:\n\nAuthorization: Basic RFNtaXRoOk1ZUGFzc1dkNjY=\n\nA returning http response code of 401 means the username or password are incorrect  ",
        "operationId": "login",
        "produces": [
          "application/json"
        ],
        "consumes": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "action",
            "in": "query",
            "description": "",
            "required": true,
            "default": "login",
            "type": "string"
          }
        ],
        "security": [
          {
            "Authorization": []
          }
        ],
        "tags": [
          "Login"
        ],
        "responses": {
          "200": {
            "description": "Response object.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/LoginResponse"
              }
            }
          },
          "default": {
            "description": "Unexpected error",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "x-ms-visibility": "advanced"
      }
    },
    "/shipping/shipment": {
      "post": {
        "summary": "Create shipment.",
        "description": "The Login API is different to all other APIs as it returns a GeoSession. The other APIs require the GeoSession to be passed in as a security validation. Calling this API also sets up a session on the Interlink servers. This server session allows all future interactions to be validated without the need to present login credentials. The API requires the username and password to be encrypted using base64 encryption and then passed as an Authorization header in the HTTP request, Example username = DSmith password = MYPassWd66 Concatenate the username and password with a colon in between and encrypt to base64 as a single string: e.g: DSmith:MYPassWd66 This would result in a string of: RFNtaXRoOk1ZUGFzc1dkNjY= This can be applied to the http request as a header of:\nAuthorization: Basic RFNtaXRoOk1ZUGFzc1dkNjY=\nA returning http response code of 401 means the username or password are incorrect  ",
        "operationId": "createshipment",
        "produces": [
          "application/json"
        ],
        "consumes": [
          "application/json"
        ],
        "security": [
          {
            "GeoSession": [
            ]
          }
        ],
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/Shipping"
            }
          }
        ],
        "tags": [
          "Shipping"
        ],
        "responses": {
          "200": {
            "description": "Response object.",
            "schema": {
              "items": {
                "$ref": "#/definitions/ShippingResponse"
              }
            }
          },
          "default": {
            "description": "Unexpected error",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "x-ms-visibility": "advanced"
      }
    },
    "/shipping/shipment/{shipmentId}/label": {
      "get": {
        "summary": "Generate label.",
        "operationId": "getlabels",
        "description": "Once a shipment has been created this API is available to pass the shipmentId returned from the insert shipment API to return label output. \nThe label can be returned in different formats by setting the appropriate accept type header. Please see available options below:   \n\ntext/vnd.citizen-clp; - For use with Citizen Thermal Printers (Please refer to prerequisites for label dimension information.) \n\ntext/vnd.eltron-epl; = Intended for use with Eltron Printer / Or certain printer models that support EPL emulation. (Please refer to prerequisites for label dimension information.) \n\ntext/html = Plain text HTML output, intended for printing to A4 laser Printer on A4 stationary. \n\nWARNING: Printing HTML output provided via API to Thermal printer may cause label outpit to be scaled under minumum requirenments and fail verification once label is received by ourselves and analysed.\n",
        "security": [
          {
            "GeoSession": []
          }
        ],
        "consumes": [
          "text/and.citizen-clp",
          "text/vnd.eltron-epl",
          "text/html"
        ],
        "parameters": [
          {
            "name": "shipmentId",
            "in": "path",
            "description": "Id of shipment.",
            "required": true,
            "type": "number",
            "format": "double"
          }
        ],
        "tags": [
          "Lables"
        ],
        "responses": {
          "200": {
            "description": "The actual print string to be sent to the printer This is not an attribute but just a string",
            "schema": {
              "type": "string"
            }
          }
        },
        "x-ms-visibility": "advanced"
      }
    }
  },
  "definitions": {
    "ShippingResponse": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "description": "An object which encapsulates errors thrown by the API ",
          "items": {
            "$ref": "#/definitions/Error"
          }
        },
        "data": {
          "type": "object",
          "description": "An object returned from the API which encapsulates the returning data ",
          "properties": {
            "shipmentId": {
              "type": "number"
            }
          }
        }
      }
    },
    "LoginResponse": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "description": "An object which encapsulates errors thrown by the API ",
          "items": {
            "$ref": "#/definitions/Error"
          }
        },
        "data": {
          "type": "object",
          "description": "An object returned from the API which encapsulates the returning data",
          "properties": {
            "geoSession": {
              "type": "string"
            }
          }
        }
      }
    },
    "Error": {
      "type": "object",
      "properties": {
        "errorAction": {
          "type": "string",
          "description": "The action associated with the errorMessage, this can be null if no action was required "
        },
        "errorCode": {
          "type": "string",
          "description": "The errorCode associated with the errorMessage "
        },
        "errorMessage": {
          "type": "string",
          "description": "An error message given for an action which was not successful "
        },
        "errorObj": {
          "type": "string",
          "description": "The object within the past in criteria which caused this exception "
        },
        "errorType": {
          "type": "string",
          "description": "The error type assigned to a error"
        }
      }
    },
    "Shipping": {
      "type": "object",
      "required": [
        "job_id",
        "collectionOnDelivery",
        "invoice",
        "collectionDate",
        "consignment"
      ],
      "properties": {
        "job_id": {
          "type": "number",
          "description": "The id associated with a collection of objects"
        },
        "collectionOnDelivery": {
          "type": "boolean",
          "description": ""
        },
        "invoice": {
          "$ref": "#/definitions/Invoice"
        },
        "collectionDate": {
          "type": "string",
          "description": "The date the Van is due to arrive to collect the parcels "
        },
        "consignment": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Consignment"
          }
        }
      }
    },
    "Consignment": {
      "type": "object",
      "required": [
        "collectionDetails",
        "deliveryDetails",
        "numberOfParcels",
        "totalWeight",
        "shippingRef1",
        "shippingRef2"
      ],
      "properties": {
        "consignmentNumber": {
          "type": "string",
          "description": "The identifier number for the delivery to the address "
        },
        "consignmentRef": {
          "type": "string",
          "description": "A link to the parent consignment number "
        },
        "parcel": {
          "$ref": "#/definitions/Parcel"
        },
        "collectionDetails": {
          "$ref": "#/definitions/CollectionDetails"
        },
        "deliveryDetails": {
          "$ref": "#/definitions/DeliveryDetails"
        },
        "networkCode": {
          "type": "string",
          "description": "The network code associated with the package"
        },
        "numberOfParcels": {
          "type": "number",
          "description": "The number of packages"
        },
        "totalWeight": {
          "type": "number",
          "description": "The total weight",
          "format": "double"
        },
        "shippingRef1": {
          "type": "string",
          "description": "The first reference associated with the shipment "
        },
        "shippingRef2": {
          "type": "string",
          "description": "The second reference associated with the shipment "
        },
        "shippingRef3": {
          "type": "string",
          "description": "The third reference associated with the shipment "
        },
        "customsValue": {
          "type": "number",
          "description": "The customs value"
        },
        "deliveryInstructions": {
          "type": "string",
          "description": "The delivery instructions associated with delivering a parcel "
        },
        "parcelDescription": {
          "type": "number",
          "description": "A small human readable description of the product "
        },
        "liabilityValue": {
          "type": "number",
          "description": "The value the product should be insured "
        },
        "liability": {
          "type": "boolean",
          "description": "Is liability required"
        }
      }
    },
    "CollectionDetails": {
      "type": "object",
      "required": [
        "contactDetails",
        "address"
      ],
      "properties": {
        "contactDetails": {
          "$ref": "#/definitions/ContactDetails"
        },
        "address": {
          "$ref": "#/definitions/Address"
        }
      }
    },
    "DeliveryDetails": {
      "type": "object",
      "required": [
        "contactDetails",
        "address",
        "notificationDetails"
      ],
      "properties": {
        "contactDetails": {
          "$ref": "#/definitions/ContactDetails"
        },
        "address": {
          "$ref": "#/definitions/Address"
        },
        "notificationDetails": {
          "$ref": "#/definitions/NotificationDetails"
        }
      }
    },
    "ContactDetails": {
      "type": "object",
      "description": "An object encapsulating contact information ",
      "properties": {
        "contactName": {
          "type": "string",
          "description": "The contact name "
        },
        "telephone": {
          "type": "string",
          "description": "A telephone number"
        }
      }
    },
    "Address": {
      "type": "object",
      "properties": {
        "organisation": {
          "type": "string",
          "description": "The organisational name assigned to a company"
        },
        "countryCode": {
          "type": "string",
          "description": "The IATA code for a country"
        },
        "addressId": {
          "type": "string",
          "description": "The identifier for a specific address"
        },
        "postcode": {
          "type": "string",
          "description": "The assigned identity aligned to the property given by the post office"
        },
        "locality": {
          "type": "string",
          "description": "A particular area"
        },
        "town": {
          "type": "string",
          "description": "The town section of an address"
        },
        "county": {
          "type": "string",
          "description": "The county section of an address"
        }
      }
    },
    "NotificationDetails": {
      "type": "object",
      "description": "An object encapsulating a recipient/customer notification ",
      "properties": {
        "email": {
          "type": "string",
          "description": "An email address"
        },
        "mobile": {
          "type": "string",
          "description": "A mobile telephone number"
        }
      }
    },
    "Invoice": {
      "type": "object",
      "description": "An object which encapsulates the international invoice details ",
      "properties": {
        "auditInfo": {
          "type": "string",
          "description": "An email address"
        },
        "countryOfOrigin": {
          "type": "string",
          "description": "A mobile telephone number"
        },
        "invoiceBillingDetails": {
          "$ref": "#/definitions/InvoiceBillingDetails"
        },
        "invoiceCustomsNumber": {
          "type": "string",
          "description": "The customs number"
        },
        "invoiceExportReason": {
          "type": "string",
          "description": "The invoice export reason"
        },
        "invoiceIsDeclared": {
          "type": "boolean",
          "description": "An indicator that an invoice is declared "
        },
        "invoiceItem": {
          "$ref": "#/definitions/InvoiceItem"
        },
        "invoiceTermsOfDelivery": {
          "type": "string",
          "description": "The international invoice terms of delivery"
        },
        "invoiceType": {
          "type": "number",
          "description": "The type of international invoice"
        },
        "totalItems": {
          "type": "string",
          "description": "The total items"
        },
        "totalValue": {
          "type": "number",
          "description": "The total value"
        },
        "totalWeight": {
          "type": "number",
          "description": "The total weight"
        }
      }
    },
    "InvoiceBillingDetails": {
      "type": "object",
      "description": "An object which encapsulates the international invoice details ",
      "properties": {
        "address": {
          "$ref": "#/definitions/Address"
        },
        "contactDetails": {
          "$ref": "#/definitions/ContactDetails"
        },
        "vatNumber": {
          "type": "string",
          "description": "A VAT number"
        }
      }
    },
    "InvoiceItem": {
      "type": "object",
      "description": "An object which encapsulates the international invoice details ",
      "properties": {
        "auditInfo": {
          "type": "object",
          "description": "An object encapsulating the records audit information\n"
        },
        "countryOfOrigin": {
          "type": "string",
          "description": "The IATA code for the country where the product originates "
        },
        "itemCode": {
          "type": "string",
          "description": "The items code"
        },
        "itemDescription": {
          "type": "string",
          "description": "The items description"
        },
        "numberOfItems": {
          "type": "number",
          "description": "The number of items"
        },
        "unitValue": {
          "type": "number",
          "description": "The unit value"
        }
      }
    },
    "Parcel": {
      "description": "An object which encapsulates all the parcels details",
      "properties": {
        "auditInfo": {
          "type": "object",
          "description": "An object encapsulating the records audit information"
        },
        "isVoided": {
          "type": "boolean",
          "description": "Used to set or find out if an object has been voided "
        },
        "labelNumber": {
          "type": "string",
          "description": "A parcel label nunber"
        },
        "packageNumber": {
          "type": "string",
          "description": "The package number within the shipment, for a 1 parcel shipment the parcels package number is 1 "
        },
        "parcelNumber": {
          "type": "number",
          "description": "The 10/11 or 14/15 digit number used to track the parcel "
        },
        "parcelProduct": {
          "$ref": "#/definitions/ParcelProduct"
        },
        "parcelnetBarcode": {
          "type": "string",
          "description": "The Hermes barcode data "
        },
        "parcelnetData": {
          "type": "number",
          "description": "Additional Hermes data associated with the barcode"
        },
        "parcelnetLabelNumber": {
          "type": "string",
          "description": "A human readable Hermes barcode reference "
        }
      }
    },
    "ParcelProduct": {
      "description": "An object which encapsulates all the parcels details",
      "properties": {
        "countryOfOrigin": {
          "type": "string",
          "description": "The IATA code for the country where the product originates "
        },
        "numberOfItems": {
          "type": "integer",
          "description": "The number of items"
        },
        "productCode": {
          "type": "string",
          "description": "An indicator identifying a DPD Group product "
        },
        "productFabricContent": {
          "type": "number",
          "description": "The fabric content associated with the product"
        },
        "productHarmonisedCode ": {
          "type": "string",
          "description": "The harmonised code associated with the product"
        },
        "productItemsDescription": {
          "type": "string",
          "description": "The human readable description of the product irems"
        },
        "productTypeDescription": {
          "type": "string",
          "description": "The human readable product type description"
        },
        "unitValue": {
          "type": "number",
          "format": "double",
          "description": "The unit value "
        },
        "unitWeight": {
          "type": "number",
          "description": "The unit weight"
        }
      }
    }
  }
}