Brutus API (1.0.0)

Download OpenAPI specification:

Bookings

Bookings

Upload a document for a booking

Authorizations:
bearerAuth
path Parameters
bookingUuid
required
string <uuid>
Example: 918f07a7-14b3-4587-aa46-69f9089dd663

Uuid of the booking

Request Body schema: multipart/form-data
required

Document to upload

documentType
required
string
Enum: "CommercialInvoice" "PackingList" "Others"

Type of document

document
required
string <binary>

Document file (PDF, CSV, or XLSX)

Responses

Response samples

Content type
application/json
{
  • "message": "The given data was invalid.",
  • "errors": {
    }
}

Book a rate

Authorizations:
bearerAuth
path Parameters
rateUuid
required
string <uuid>
Example: 918f07a7-14b3-4587-aa46-69f9089dd663

Uuid of the rate

Request Body schema: application/json

Book a rate by rateUuid

currency
required
string
lang
string
Enum: "es_ES" "en_US"
required
object (ServicesSelected)

Details of the services selected

required
object
required
Array of objects (OptionalBillingItemSelectionData)

Property used to book optional additional services.

Responses

Request samples

Content type
application/json
{
  • "currency": "EUR",
  • "lang": "es_ES",
  • "servicesSelected": {
    },
  • "bookingDetails": {
    },
  • "optionalBillingItems": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get booking details

Authorizations:
bearerAuth
path Parameters
bookingUuid
required
string <uuid>
Example: 918f07a7-14b3-4587-aa46-69f9089dd663

Uuid of the booking

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Download booking document

Authorizations:
bearerAuth
path Parameters
bookingUuid
required
string <uuid>
Example: 918f07a7-14b3-4587-aa46-69f9089dd663

Uuid of the booking

documentId
required
string
Example: WcOADB4ddQXukNi6cvZVm6SLOrJUlNF5AGYFh-mbxHZNXKpMB8-QdC5AGsiBbJ6cIxFDMRHzb4glE3ngExtiTcdC

Id of the document

Responses

Response samples

Content type
application/json

Get booking track and trace information

Authorizations:
bearerAuth
path Parameters
bookingUuid
required
string <uuid>
Example: 918f07a7-14b3-4587-aa46-69f9089dd663

Uuid of the booking

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Places

Places

Search places for aerial transportation

This method return valid results for aerial places to use in a aerial quotation later on

Authorizations:
bearerAuth
query Parameters
term
required
string <= 400 characters
Example: term=bar

Term to search for places

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Search places for maritime transportation options (FCL/LCL).

This method return valid results for aerial places to use in a maritime (FCL/LCL) quotation later on

Authorizations:
bearerAuth
query Parameters
term
required
string <= 400 characters
Example: term=bar

Term to search for places

shipmentType
required
string = 3 characters
Enum: "FCL" "LCL"
Example: shipmentType=FCL

Shipment type, I.e FCL or LCL

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Quotes

Quotes

Create a new FCL Quote

Authorizations:
bearerAuth
Request Body schema: application/json

New quote

currency
required
string
Default: "EUR"
lang
required
string
Default: "en_US"
commodityType
string or null
Enum: "Regular Cargo" "Refrigerated" "Hazardous goods (DGR, IMO)" "Perishable" "Used Tires/Scrap" "Household Goods" "Livestock and Animals"
maxExecutionTime
number or null <int32>

The number of seconds to wait for the quote to be processed.

required
any (MaritimeQuoteLocationRequest)
required
any (MaritimeQuoteLocationRequest)
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "currency": "EUR",
  • "lang": "es_ES",
  • "commodityType": "Regular Cargo",
  • "maxExecutionTime": 0,
  • "origin": {
    },
  • "destination": {
    },
  • "containers": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a new LCL Quote

Authorizations:
bearerAuth
Request Body schema: application/json

New quote

currency
required
string
Default: "EUR"
lang
required
string
Default: "en_US"
commodityType
string or null
Enum: "Regular Cargo" "Refrigerated" "Hazardous goods (DGR, IMO)" "Perishable" "Used Tires/Scrap" "Household Goods" "Livestock and Animals"
maxExecutionTime
number or null <int32>

The number of seconds to wait for the quote to be processed.

required
any (MaritimeQuoteLocationRequest)
required
any (MaritimeQuoteLocationRequest)
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "currency": "EUR",
  • "lang": "es_ES",
  • "commodityType": "Regular Cargo",
  • "maxExecutionTime": 0,
  • "origin": {
    },
  • "destination": {
    },
  • "cargo": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a new Air Quote

Authorizations:
bearerAuth
Request Body schema: application/json

New quote

currency
required
string
Default: "EUR"
lang
required
string
Default: "en_US"
commodityType
string or null
Enum: "Regular Cargo" "Refrigerated" "Hazardous goods (DGR, IMO)" "Perishable" "Used Tires/Scrap" "Household Goods" "Livestock and Animals"
maxExecutionTime
number or null <int32>

The number of seconds to wait for the quote to be processed.

required
Array of objects
isKnownShipper
boolean
Default: true
required
any (AerialQuoteLocationRequest)
required
any (AerialQuoteLocationRequest)
cargoReadyDate
string <date>

Responses

Request samples

Content type
application/json
{
  • "currency": "EUR",
  • "lang": "es_ES",
  • "commodityType": "Regular Cargo",
  • "maxExecutionTime": 0,
  • "cargo": [
    ],
  • "isKnownShipper": true,
  • "origin": {
    },
  • "destination": {
    },
  • "cargoReadyDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a new Ltl Quote

Authorizations:
bearerAuth
Request Body schema: application/json

New quote

currency
required
string
Default: "EUR"
lang
required
string
Default: "en_US"
commodityType
string or null
Enum: "Regular Cargo" "Refrigerated" "Hazardous goods (DGR, IMO)" "Perishable" "Used Tires/Scrap" "Household Goods" "Livestock and Animals"
maxExecutionTime
number or null <int32>

The number of seconds to wait for the quote to be processed.

required
Array of objects
freightClass
string or null
Enum: "50" "55" "60" "65" "70" "77.5" "85" "92.5" "100" "110" "125" "150" "175" "200" "250" "300" "400" "500"
required
object (PostalCodeQuoteLocationRequest)
required
object (PostalCodeQuoteLocationRequest)
cargoReadyDate
string or null <date>

Responses

Request samples

Content type
application/json
{
  • "currency": "EUR",
  • "lang": "es_ES",
  • "commodityType": "Regular Cargo",
  • "maxExecutionTime": 0,
  • "cargo": [
    ],
  • "freightClass": "50",
  • "origin": {
    },
  • "destination": {
    },
  • "cargoReadyDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "message": "The given data was invalid.",
  • "errors": {
    }
}

Get Quote by Uuid

Authorizations:
bearerAuth
path Parameters
uuid
required
string <uuid>
Example: 918f07a7-14b3-4587-aa46-69f9089dd663

Uuid of the quote

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "quotedAt": "2019-08-24T14:15:22Z",
  • "currency": "EUR",
  • "lang": "es_ES",
  • "rates": [
    ],
  • "quoteType": "Instant quote",
  • "completed": true,
  • "origin": {
    },
  • "destination": {
    },
  • "items": [
    ],
  • "shipmentType": "FCL",
  • "data": {
    }
}

Rates

Rates

Calculate Prices for a Rate

Authorizations:
bearerAuth
path Parameters
rateUuid
required
string <uuid>
Example: 918f07a7-14b3-4587-aa46-69f9089dd663

Uuid of the rate

Request Body schema: application/json

New quote

currency
required
string (Currency)
required
Array of objects (OptionalBillingItemSelectionData)
required
object (ServicesSelected)

Details of the services selected

lang
required
string
Enum: "es_ES" "en_US"

Responses

Request samples

Content type
application/json
{
  • "currency": "EUR",
  • "optionalBillingItems": [
    ],
  • "servicesSelected": {
    },
  • "lang": "es_ES"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}