Explorate logo
API docs by Redocly

Explorate API Documentation (1.0.0)

Download OpenAPI specification:Download

License: Apache 2.0

About Explorate

Our industry, freight forwarding and international trade, is one of the last to be disrupted by digital innovation. Explorate is creating a simpler way to do complicated shipments by developing its own online platform. Built by logistics experts and powered by cutting-edge technology, we empower our shippers with instant quotes and bookings, real-time track & trace, digital dashboards and faultless workflow management.

Getting Started

Here you will learn how to get your API Key, making an API call, how to receive help in case you get stuck and much more. The Explorate API has been designed for use of ease but there are a few things that need to happen or you need to know before you can start developing against it.

Onboarding

Note, Developer Tools are only available to Company Managers at this time. Please contact us at devsupport@explorate.co for further assistance.

Credentials

Company managers can find Developer Tools in the navigation bar under the User tab (where it says Hello, {Your Name}). Here, you will find API Management and Shareable Shipments. This allows you to create a new API key and assign a nickname to it. Please note, this key must be stored somewhere safe as it cannot be displayed by us again. To use the key, you will be hitting one of our public endpoints with the key as an authorization header bearer token. All keys have Manager level access.

Quote

Includes details relating to carrier, container(s), ports, shipment type and status.

Find all quotes

Authorizations:
ApiKeyAuth
query Parameters
limit
integer

Number of quotes returned

offset
integer

Query result offset

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Find a quote

Authorizations:
ApiKeyAuth
path Parameters
ref
string

Quote reference

Responses

Response samples

Content type
application/json
{
  • "carrier": {
    },
  • "containers": {
    },
  • "destinationPort": {
    },
  • "originPort": {
    },
  • "ref": "GA8NPD",
  • "shipmentType": "FCL",
  • "status": "ACCEPTED"
}

Shipment

Includes details relating to type, carrier, dates, times, ports, status, supplier and equipment.

Find all shipments

Authorizations:
ApiKeyAuth
query Parameters
limit
integer

Number of shipments returned

page
integer

Query result page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find a shipment

Authorizations:
ApiKeyAuth
path Parameters
ref
string

Shipment reference

Responses

Response samples

Content type
application/json
{
  • "explShipmentId": "EXPL3762C",
  • "Containers": [
    ],
  • "Equipments": null,
  • "actualArrivalDate": "2022-08-11T00:00:00.000Z",
  • "actualDepartureDate": "2022-08-06T00:00:00.000Z",
  • "carrier": {
    },
  • "deliveryDate": "2022-08-14T00:00:00.000Z",
  • "deliveryTime": "08:30 - 14:45",
  • "destinationPort": {
    },
  • "estimatedArrivalDate": "2022-08-13T00:00:00.000Z",
  • "estimatedDepartureDate": "2022-08-05T00:00:00.000Z",
  • "incoterm": "FOB",
  • "internalReference": "HS92384",
  • "originPort": {
    },
  • "pickupDate": "2022-08-01T00:00:00.000Z",
  • "pickupTime": "",
  • "shipmentType": "FCL",
  • "status": "PROCESSING",
  • "supplier": [
    ],
  • "totalCost": 250749.41,
  • "totalCostExTax": 249249.41,
  • "vesselName": "EVER GIVEN",
  • "vesselImo": "9216689"
}

Purchase Order

Includes details relating to purchase orders.

Find all purchase orders

Authorizations:
ApiKeyAuth
query Parameters
limit
integer

Number of purchase orders returned

offset
integer

Query result offset

number
string

The purchase order number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a file of any extension to an existing purchase order

Authorizations:
ApiKeyAuth
Request Body schema: application/json

JSON to describe the PO and its lines

number
string
erpStatus
string
erpSystemDate
string
supplierName
string
Array of objects
custom
object

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "erpStatus": "string",
  • "erpSystemDate": "string",
  • "supplierName": "string",
  • "lines": [
    ],
  • "custom": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "OPEN",
  • "erpStatus": "UNKNOWN",
  • "erpSystemDate": "UNKNOWN",
  • "pendingChanges": {
    },
  • "lines": [
    ]
}

Find a purchase order

Authorizations:
ApiKeyAuth
query Parameters
id
required
integer

Purchase order id

Responses

Response samples

Content type
application/json
{
  • "PurchaseOrderFiles": [
    ],
  • "PurchaseOrderLines": [
    ],
  • "id": 2,
  • "number": "BON398",
  • "status": "OPEN",
  • "urgent": false
}

Add a file of any extension to an existing purchase order

Authorizations:
ApiKeyAuth
path Parameters
id
integer

Purchase Order Id

Request Body schema: multipart/form-data

An optional but relevant description of the file

object

Responses

Updates the Explorate and External status of a purchase order

Authorizations:
ApiKeyAuth
path Parameters
id
integer

Purchase Order Id

Request Body schema: application/json

JSON object of purchase order status details

object

Responses

Request samples

Content type
application/json
{
  • "status": "OPEN",
  • "erpStatus": "ERP_STATUS"
}

Response samples

Content type
application/json
{
  • "id": 216,
  • "status": "OPEN",
  • "erpStatus": "ERP_STATUS"
}

Port

Includes details relating to ports.

Find port details

Authorizations:
ApiKeyAuth
query Parameters
country
required
string
Example: country=Australia

The country the port is in

city
required
string
Example: city=Brisbane

The city the port is in

Responses

Response samples

Content type
application/json
{
  • "code": "AUBNE"
}

File

Includes details relating to files.

Download a file

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the requested file

Responses

Upload a file

Authorizations:
None
Request Body schema: multipart/form-data
file
string <binary>

The file to upload

description
string

An optional description of the uploaded file

Responses

Response samples

Content type
application/json
{
  • "id": 216
}

Containers

Includes details relating to shipment containers.

Find all containers

Authorizations:
ApiKeyAuth
query Parameters
limit
integer

Number of containers returned

page
integer

Pagination for containers

scac
string

Carrier code

status
string

Shipment status

explShipmentId
string

Shipment explShipmentId

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pages": 1
}

Incoterm

Incoterms specify who is responsible for paying for and managing the shipment, insurance, documentation, customs clearance, and other logistical activities.

  • EXW - Door-to-Door
  • FOB - Port-to-Door
  • CIF - Port-to-Door
  • CIP - Door-to-Port
  • CFR - Door-to-Port
  • CPT - Door-to-Port
  • DAT - Door-to-Door
  • DAP - Door-to-Door
  • DDP - Door-to-Door
  • FAS - Port-to-Port
  • FCA - Port-to-Port
  • CIF - Customs-and-Delivery
  • CIF - Customs-Clearance-Only

ShipmentType

Shipment Type refers to a land, sea or air cargo booking.

  • FCL - Full Container Load. Has own container subtypes.
  • LCL - Less than Container Load. Part of a full container is booked.
  • RORO - Roll On Roll Off. Describes how machines are loaded on and off vessels.
  • AIR - Air Freight

Quote-Status

Status indicates the present condition of the quote.

  • DRAFT - Work in progress
  • REQUESTED - Request sent through
  • ACCEPTED - Quote accepted
  • VIEWED - Quote has been seen
  • AVAILABLE - Quote available
  • PENDING - Awaiting outcome
  • REJECTED - Quote rejected
  • EXPIRED - Quote no longer valid
  • ARCHIVED - Quote removed

Shipment-Status

Status indicates the present condition of the shipment.

  • PROCESSING - Administration work in progress
  • CONFIRMED - Approved by all parties
  • COMPLETED - Arrived and cleared
  • CANCELLED - Voided