logo
API docs by Redocly

Brutus API (1.0.0)

Download OpenAPI specification:

E-mail: devsupport@icontainers.com License: private

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

Repeated OpenAPI references and Laravel validation strings are kept inline instead of extracting constants.

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.

object or null

Optional addresses to associate with the booking. Each key is an address type (shipper, consignee, pickup, delivery, billing).

Responses

Request samples

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

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> <= 180

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

required
any (MaritimeQuoteLocationRequest)
required
any (MaritimeQuoteLocationRequest)
bestOffer
boolean
Default: false
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "currency": "EUR",
  • "lang": "es_ES",
  • "commodityType": "Regular Cargo",
  • "maxExecutionTime": 180,
  • "origin": {
    },
  • "destination": {
    },
  • "bestOffer": false,
  • "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> <= 180

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

required
any (MaritimeQuoteLocationRequest)
required
any (MaritimeQuoteLocationRequest)
bestOffer
boolean
Default: false
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "currency": "EUR",
  • "lang": "es_ES",
  • "commodityType": "Regular Cargo",
  • "maxExecutionTime": 180,
  • "origin": {
    },
  • "destination": {
    },
  • "bestOffer": false,
  • "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> <= 180

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)
bestOffer
boolean
Default: false
cargoReadyDate
string <date>

Responses

Request samples

Content type
application/json
{
  • "currency": "EUR",
  • "lang": "es_ES",
  • "commodityType": "Regular Cargo",
  • "maxExecutionTime": 180,
  • "cargo": [
    ],
  • "isKnownShipper": true,
  • "origin": {
    },
  • "destination": {
    },
  • "bestOffer": false,
  • "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> <= 180

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": 180,
  • "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

query Parameters
bestOffer
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "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": {
    }
}

Documents

Documents

Get document content by ID

Authorizations:
bearerAuth
path Parameters
documentId
required
string
Example: booking.918f07a7-14b3-4587-aa46-69f9089dd663.550e8400-e29b-41d4-a716-446655440000

Document identifier in the format objectType.objectId.documentId

Responses

Response samples

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

Get document content by ID

Authorizations:
bearerAuth
path Parameters
documentId
required
string
Example: booking/918f07a7-14b3-4587-aa46-69f9089dd663/550e8400-e29b-41d4-a716-446655440000

Document identifier in the format objectType/objectId/documentId

Responses

Response samples

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

Ecommerce / Incoming packages

Submit pre-alerts, find received packages, and read incoming tracking events.

Find package tracking events

Authorizations:
bearerAuth
query Parameters
incomingTrackingNumber
required
string

Responses

Response samples

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

Find confirmed received packages

Authorizations:
bearerAuth
query Parameters
incomingTrackingNumber
required
string
hubCode
string
Enum: "USA" "UAE" "UK" "DE" "CN" "HK"

Responses

Response samples

Content type
application/json
{
  • "code": "200",
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

Create or replace expected package contents

Authorizations:
bearerAuth
Request Body schema: application/json
required
hubCode
required
string
Enum: "USA" "UAE" "UK" "DE" "CN" "HK"
incomingTrackingNumber
required
string <= 255 characters
carrierCode
string or null^[A-Z]{2,4}$

SCAC. Unmapped codes are preserved.

required
object

Responses

Request samples

Content type
application/json
{
  • "hubCode": "USA",
  • "incomingTrackingNumber": "string",
  • "carrierCode": "string",
  • "package": {
    }
}

Response samples

Content type
application/json
{
  • "code": "200",
  • "success": true,
  • "message": "Pre-alert saved."
}

Ecommerce / Orders

Create orders and manage labels and documents.

Confirm pickup readiness for one SPX order

Use no request body. Only LAST_MILE or FIRST_MILE orders with status New can be confirmed. FIRST_MILE uses the confirmation date in Dubai for pickup and starts the first mile booking process. A repeat returns alreadyConfirmed=true and does not start another booking. A cancelled order is rejected. Retry the same order ID after a timeout or 502. Acceptance does not mean that the carrier booking is complete.

Authorizations:
bearerAuth
path Parameters
orderId
required
string = 12 characters ^[A-Za-z0-9]{12}$
Example: SPXAPDQI6K6Z

Responses

Response samples

Content type
application/json
{
  • "code": "200",
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

Create an OMS order

Create one order with one package. Customer context comes from the Bearer token. Retain data.orderId for labels and documents. This operation has no idempotency guarantee. Check an uncertain result before you submit again.

Authorizations:
bearerAuth
Request Body schema: application/json
required
One of
serviceType
required
string
Default: "LAST_MILE"
Enum: "LAST_MILE" "FIRST_MILE" "RECEIVING_AND_LAST_MILE" "END_TO_END"

FIRST_MILE: collection and transport to a hub. LAST_MILE: delivery from a hub to the consignee. RECEIVING_AND_LAST_MILE: receipt of an incoming package and final delivery. END_TO_END: collection through final delivery. Only omission selects LAST_MILE; null is not accepted.

receivingHubCode
required
string
Enum: "USA" "UAE" "UK" "DE" "CN" "HK"

The hub that receives the package. Required only for RECEIVING_AND_LAST_MILE. Not accepted for other service types.

incomingTrackingNumber
string [ 1 .. 255 ] characters ^[^\x00-\x1F\x7F]*[^\x00-\x20\x7F][^\x00-\x1F...

The tracking number of the incoming package. Optional for RECEIVING_AND_LAST_MILE. Not accepted for other service types. Control characters are not accepted.

customerReference
string or null <= 255 characters
required
object (Ecommerce.OrderPartyV1)
required
object (Ecommerce.OrderPartyV1)
required
object (Ecommerce.OrderPackageV1)

Responses

Request samples

Content type
application/json
{
  • "serviceType": "LAST_MILE",
  • "package": {
    },
  • "customerReference": "API-123",
  • "shipper": {
    },
  • "consignee": {
    }
}

Response samples

Content type
application/json
{
  • "code": "201",
  • "success": true,
  • "message": "Successful",
  • "data": {
    }
}

Download an OMS order label

Use data.orderId from order creation. The order must belong to the customer associated with the token. A successful response is a PDF file, not JSON.

Authorizations:
bearerAuth
path Parameters
orderId
required
string = 12 characters ^[A-Za-z0-9]{12}$
Example: E123456ABCDE

Responses

Response samples

Content type
application/json
{
  • "message": "The application has no customer context."
}

Update incoming package data for an order

Supply or correct tracking, dimensions, or the complete item list for a RECEIVING_AND_LAST_MILE order before warehouse receipt. Omitted fields keep their values. Supplied dimensions and items replace their previous values. After receipt, all updates are blocked. One incoming package belongs to each order.

Authorizations:
bearerAuth
path Parameters
orderId
required
string^SPX[A-Za-z0-9]{9}$
Request Body schema: application/json
required
non-empty
incomingTrackingNumber
string [ 1 .. 255 ] characters ^[^\x00-\x1F\x7F]*[^\x00-\x20\x7F][^\x00-\x1F...
object non-empty

Responses

Request samples

Content type
application/json
{
  • "incomingTrackingNumber": "string",
  • "package": {
    }
}

Response samples

Content type
application/json
{
  • "code": "200",
  • "success": true,
  • "message": "Successful",
  • "data": {
    }
}

Upload an OMS order document

Use data.orderId from order creation. Send base64 file content in JSON, without a data URL prefix. The order must belong to the customer associated with the token.

Authorizations:
bearerAuth
path Parameters
orderId
required
string = 12 characters ^[A-Za-z0-9]{12}$
Example: E123456ABCDE
Request Body schema: application/json
required
fileName
required
string <= 255 characters
documentType
required
string
Enum: "CommercialInvoice" "PackingList"
documentBase64
required
string <byte> <= 13981016 characters

Base64 file content. PDF, JPEG, or PNG. Maximum decoded size: 10 MiB.

Responses

Request samples

Content type
application/json
{
  • "fileName": "packing-list.pdf",
  • "documentType": "PackingList",
  • "documentBase64": "JVBERi0xLjQKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyA+PgplbmRvYmoKJSVFT0YK"
}

Response samples

Content type
application/json
{
  • "code": "201",
  • "success": true,
  • "message": "Successful",
  • "data": {
    }
}

Amazon

Amazon