Overview

Carrier API(BETA) (1.0.0)

The Carrier API introduces the opportunity to add support for carriers not natively integrated with Veeqo. By responding to the HTTP requests and formats set out in this documentation, you will be able to see quotes, print labels and track shipments of your desired carrier in Veeqo.

Note: The Carrier API is currently only available to sellers in the UK.

Carrier Setup

The setup of the carrier requires some basic information to be added in Veeqo. The configuration can be added once logged in and visiting the setup page. The information required is broken down as follows

Field	Description
Base URL	This is the public facing URL, that your app will receive and respond to HTTP requests, i.e https://myapp.shipping.com
Name	The presentable name of the carrier. This name will be shown as the carrier name in Veeqo as well as in email confirmations sent to customers
Tracking URL	The URL that the shipment tracking information will be accessible at. It will be used in Veeqo and shipping confirmation emails to customers. The URL is configurable in the format of, http://tracking.shipping.com?id=[tracking_number] with [tracking_number] being replaced by Veeqo with the tracking number of the shipment, i.e http://tracking.shipping.com?id=123456789
External Carrier Name	Optional. Use this option to provide the name of the external carrier used for shipping your external marketplace orders. This value will be passed onto external marketplaces (ideal for custom integrations that only support one carrier).

When you have added this information, you will be given a token. This token will be sent in all requests by Veeqo. It should be stored securely and be used to identify the Veeqo customer using your shipping app.

Authentication For Veeqo Requests

All requests from Veeqo to your shipping app will include an authentication header with the token for the app(created when setting up the carrier in Veeqo). You should verify that the token given in the Authentication header matches what you expect from Veeqo.

Example Headers

POST /quotes HTTP/1.1
Content-Type: application/json
Authentication: 123456789
Connection: close
Host: localhost:3003
Content-Length: 771

Request and Response Format

Requests from Veeqo to your Shipping app will be made in JSON format. Responses are also required in JSON. All requests will be made to your Base URL configured during the setup with the action endpoints detailed in this documentation.

The request attributes detailed in this documentation will be the data your shipping app should be setup to recieve from Veeqo, with the reponse matching the specification.

• OpenAPI version: 3.0.0