Mojito360
API docs by Redocly

Mojito360 Public API (v1)

Download OpenAPI specification:Download

Contact: support@mojito360.com URL: https://mojito360.com License: Apache 2.0 Terms of Service
Download the PostMan collection of Mojito360 Public API

Introduction

With the Mojito360 public API you can manage your company's shipments.

In order to use the API you need to configure OAUTH2 authentication to obtain the token and be able to make queries.

You will only be able to operate with those companies in which you have access from the API

You must specify the x-company field as the header with the ID of the company to which you want to make queries.

If you enter data from a company that you do not have access to, you will receive a 401 Unauthorized error

Authentication

Mojito360 requires authentication using OAuth2

OAuth2 - an open protocol to enable secure authorization in a simple and standard way from web, mobile and desktop applications

oauth2

Security Scheme Type: OAuth2
Flow type: clientCredentials
Token URL: https://sso.mojito360.com/connect/token
Scopes:
  • public_api -

    Public Api

Master data

Get alerts records.

This operation allows you to retrieve alert records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
userEmail
required
string

The UserEmail to get.

alertCategory
string (AlertCategory)
Enum: "AdvancedAlert" "DocumentaryAlert" "DocumentaryValidation"

The AlertType to get.

startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get client types records.

This operation allows you to retrieve client types records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get commodity records.

This operation allows you to retrieve commodity category records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get container types records.

This operation allows you to retrieve container types records, and it returns a response based on the status of the operation.

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Get document types records for a specific company.

This operation allows you to retrieve document types records based on the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which to retrieve document records.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Get notification records.

This operation allows you to retrieve notification records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
alertId
required
integer <int32>

The AlertId to get.

alertCategory
required
string (AlertCategory)
Enum: "AdvancedAlert" "DocumentaryAlert" "DocumentaryValidation"

The AlertCategory to get.

startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get package type records.

This operation allows you to retrieve package type records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get shipment status records.

This operation allows you to retrieve shipment status records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get shipment type records.

This operation allows you to retrieve shipment type records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get shipping line records.

This operation allows you to retrieve shipping line records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get terminal records.

This operation allows you to retrieve terminal records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Create a new terminal.

Creates a new terminal with allowed TerminalType values.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>
Request Body schema: application/json
terminalType
required
string non-empty

The type of the terminal being created.

id
integer <int32>

Gets or sets the ID of the terminal.

code
string or null <= 10 characters

Gets or sets the UN/LOCODE of the terminal (Max 10 characters).

name
string or null <= 50 characters

Gets or sets the name of the terminal (Max 50 characters).

city
string or null <= 50 characters

Gets or sets the city of the terminal (Max 50 characters).

country
string or null

Gets or sets the Country of the terminal.

latitude
number <double>

Gets or sets the latitude of the terminal.

longitude
number <double>

Gets or sets the longitude of the terminal.

Responses

Request samples

Content type
application/json
{
  • "terminalType": "string",
  • "id": 0,
  • "code": "string",
  • "name": "string",
  • "city": "string",
  • "country": "string",
  • "latitude": 0,
  • "longitude": 0
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Update an existing terminal.

Updates a terminal with allowed TerminalType values.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>
Request Body schema: application/json
id
required
integer <int32>

The unique identifier of the terminal being updated.

terminalType
required
string non-empty

The type of the terminal being updated.

code
string or null <= 10 characters

Gets or sets the UN/LOCODE of the terminal (Max 10 characters).

name
string or null <= 50 characters

Gets or sets the name of the terminal (Max 50 characters).

city
string or null <= 50 characters

Gets or sets the city of the terminal (Max 50 characters).

country
string or null

Gets or sets the Country of the terminal.

latitude
number <double>

Gets or sets the latitude of the terminal.

longitude
number <double>

Gets or sets the longitude of the terminal.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "terminalType": "string",
  • "code": "string",
  • "name": "string",
  • "city": "string",
  • "country": "string",
  • "latitude": 0,
  • "longitude": 0
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Delete a terminal.

Deletes a terminal by Id.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>
Request Body schema: application/json
id
required
integer <int32>

The unique identifier of the terminal to be deleted.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get terminal type records.

This operation allows you to retrieve terminal type records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get vessel records.

This operation allows you to retrieve vessel records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Jobs

Get function information by instance ID.

This operation allows you to retrieve function information by providing its instance ID

Authorizations:
oauth2
path Parameters
instanceId
required
string

The function instance identifier

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Commodity

Creates a new commodity record for a specific company.

This operation allows you to add a commodity with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the commodity is being created.

Request Body schema: application/json

The payload containing commodity details.

Array of objects or null (PackagePayload)

A collection of Packages associated with the commodity.

sku
string or null

The Stock Keeping Unit (SKU) of the commodity.

description
string or null

The description of the commodity.

weight
number or null <float>

The weight of the commodity.

amount
integer or null <int32>

The amount or quantity of the commodity.

Responses

Request samples

Content type
application/json
{
  • "packages": [
    ],
  • "sku": "string",
  • "description": "string",
  • "weight": 0,
  • "amount": 0
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Update a commodity record for a specific company.

This operation allows you to update a commodity with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the commodity is being updated.

Request Body schema: application/json

The payload containing commodity details.

id
integer <int32>

Id of commodity

Array of objects or null (PackagePayload)

A collection of Packages associated with the commodity.

sku
string or null

The Stock Keeping Unit (SKU) of the commodity.

description
string or null

The description of the commodity.

weight
number or null <float>

The weight of the commodity.

amount
integer or null <int32>

The amount or quantity of the commodity.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "packages": [
    ],
  • "sku": "string",
  • "description": "string",
  • "weight": 0,
  • "amount": 0
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Delete a commodity records for a specific company.

This operation allows you to delete a commodity with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the commodity are being deleted.

Request Body schema: application/json

The payload containing commodity ids.

ids
Array of integers or null <int32>

A ids of Commodity to delete

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Get commodities records for a specific company.

This operation allows you to retrieve commodity records based on the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

The identifier of the company for which to retrieve commodity records.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Companies

Get company records for user.

This operation allows you to retrieve companies records available for the user, and it returns a response based on the status of the operation.

Authorizations:
oauth2

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Creates a new company.

Allows you to create a new company with associated users.

Authorizations:
oauth2
Request Body schema: application/json
companyName
string or null

The name of the company.

users
Array of strings or null

List of users associated with the company.

Responses

Request samples

Content type
application/json
{
  • "companyName": "string",
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get company information by customer reference.

This operation allows you to retrieve the company information (ID and name) associated with a customer reference, considering user access permissions to the company.

Authorizations:
oauth2
path Parameters
customerRef
required
string

The customer reference to search for.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Updates an existing company.

Allows you to update the data of an existing company.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>
Request Body schema: application/json
companyId
integer <int32>

The unique identifier for the company.

companyName
string or null

The name of the company.

users
Array of strings or null

List of users associated with the company.

Responses

Request samples

Content type
application/json
{
  • "companyId": 0,
  • "companyName": "string",
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Deletes a company.

Allows you to delete an existing company.

Authorizations:
oauth2
path Parameters
companyId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Containers

Creates a new container record for a specific company.

This operation allows you to add a containers with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the container is being created.

Request Body schema: application/json

The payload containing container details.

shipmentId
integer <int32>

The unique identifier of the container.

customerRef
string or null
Array of objects or null (CreateShipmentContainerPayload)

The list of containers for a shipment. Each object in the list represents a container data for the shipment.

Responses

Request samples

Content type
application/json
{
  • "shipmentId": 0,
  • "customerRef": "string",
  • "containers": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Update a container record for a specific company.

This operation allows you to update a container with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the container is being updated.

Request Body schema: application/json

The payload containing container details.

shipmentId
integer <int32>

Gets or Sets the Shipment ID.

customerRef
string or null

Gets or Sets the Customer reference.

Array of objects or null (UpdateShipmentContainerPayload)

Gets or Sets the list of Containers to update for a Shipment. Assumes the use of a Mojito.PublicAPI.Models.Payloads.V1.Shipment.Update.UpdateShipmentContainerPayload for each container.

Responses

Request samples

Content type
application/json
{
  • "shipmentId": 0,
  • "customerRef": "string",
  • "containers": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Delete a containers records for a specific company.

This operation allows you to delete a containers with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the shipments are being deleted.

Request Body schema: application/json

The payload containing containers references.

shipmentId
integer <int32>
customerRef
string or null
containerRefs
Array of strings or null

The System.Collections.Generic.IEnumerable`1 of container references which are designed to be deleted. System.String objects are utilized as references.

Responses

Request samples

Content type
application/json
{
  • "shipmentId": 0,
  • "customerRef": "string",
  • "containerRefs": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Get containers records for a specific company.

This operation allows you to retrieve container records based on the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

The identifier of the company for which to retrieve containers records.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Creates a new container record for a specific company.

This operation allows you to add a containers with the provided payload, and it returns a response with the status URL of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the container is being created.

Request Body schema: application/json

The payload containing container details.

shipmentId
integer <int32>

The unique identifier of the container.

customerRef
string or null
Array of objects or null (CreateShipmentContainerPayload)

The list of containers for a shipment. Each object in the list represents a container data for the shipment.

Responses

Request samples

Content type
application/json
{
  • "shipmentId": 0,
  • "customerRef": "string",
  • "containers": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Update a container record for a specific company.

This operation allows you to update a container with the provided payload, and it returns a response with the status URL of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the container is being updated.

Request Body schema: application/json

The payload containing container details.

shipmentId
integer <int32>

Gets or Sets the Shipment ID.

customerRef
string or null

Gets or Sets the Customer reference.

Array of objects or null (UpdateShipmentContainerPayload)

Gets or Sets the list of Containers to update for a Shipment. Assumes the use of a Mojito.PublicAPI.Models.Payloads.V1.Shipment.Update.UpdateShipmentContainerPayload for each container.

Responses

Request samples

Content type
application/json
{
  • "shipmentId": 0,
  • "customerRef": "string",
  • "containers": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Delete a containers records for a specific company.

This operation allows you to delete a containers with the provided payload, and it returns a response with the status URL of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the shipments are being deleted.

Request Body schema: application/json

The payload containing containers references.

shipmentId
integer <int32>
customerRef
string or null
containerRefs
Array of strings or null

The System.Collections.Generic.IEnumerable`1 of container references which are designed to be deleted. System.String objects are utilized as references.

Responses

Request samples

Content type
application/json
{
  • "shipmentId": 0,
  • "customerRef": "string",
  • "containerRefs": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Documents

Creates a new documents records for a specific company using the provided payload.

This operation allows you to add a documents with the provided payload, and it returns a response based on the status of the operation.
ShipmentIds contains an array of the ids of the shipments to which you want to upload the files
DocumentTypes contains an array of the identifiers of the document types to be uploaded
Documents contains an array of the documents you want to upload in binary format
The three arrays must be of the same length and correlative in position to each other.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the document is being created.

x-referenceField
string

The reference of the field for search

Request Body schema: multipart/form-data
documents
required
Array of strings <binary> [ items <binary > ]

The list of document file instances representing the document files.

shipmentIds
Array of integers <int32> [ items <int32 > ]

The list of shipment IDs for the documents.

referenceFieldValue
string

The value of ReferenceFieldHeader for the documents.

documentTypes
required
Array of integers <int32> [ items <int32 > ]

The list of document types corresponding to the documents.

replace
boolean

Bool if must replace the document if alredy exists (false by default)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Update a document record for a specific company using the provided payload.

This operation allows you to update a document with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the document is being created.

Request Body schema: application/json

The payload containing information for update the document.

id
required
integer <int32>

The ID of the document to be updated.

shipmentId
required
integer <int32>

The shipment ID associated with the document.

documentTypeId
required
integer <int32>

The document type ID associated with the document.

filename
string or null

The document name.

createdBy
string or null

The user who created the document.

createdOn
string <date-time>

The date and time when the document was created.

modifiedBy
string or null

The user who last modified the document.

modifiedOn
string <date-time>

The date and time when the document was last modified.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "shipmentId": 0,
  • "documentTypeId": 0,
  • "filename": "string",
  • "createdBy": "string",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "modifiedBy": "string",
  • "modifiedOn": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Get documents records for a specific company.

This operation allows you to retrieve documents records based on the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

The identifier of the company for which to retrieve document records.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Delete a document records for a specific company.

This operation allows you to delete a documents with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the document are being deleted.

Request Body schema: application/json

The payload containing document ids.

ids
required
Array of integers <int32> [ items <int32 > ]

A ids of documents to delete

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Creates a new documents records for a specific company using the provided payload.

This operation allows you to add a documents base64 with the provided payload, and it returns a response based on the status of the operation.
The three arrays must be of the same length and correlative in position to each other.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the document is being created.

x-referenceField
string

The reference of the field for search

Request Body schema: application/json

The payload containing information for creating the document, the document is in base64.

fileName
required
string non-empty

The list of string instances representing the document name.

document
required
string non-empty

The list of base64 string representing the document files.

shipmentId
integer <int32>

Shipment ID for the documents.

referenceFieldValue
string or null

The value of ReferenceFieldHeader for the documents.

documentType
required
integer <int32>

Document type corresponding to the document.

replace
boolean

Bool if must replace the document if alredy exists (false by default)

Responses

Request samples

Content type
application/json
{
  • "fileName": "string",
  • "document": "string",
  • "shipmentId": 0,
  • "referenceFieldValue": "string",
  • "documentType": 0,
  • "replace": true
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Updates the binary file of an existing document.

Allows updating the binary file of an existing document by sending a file in form-data.

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

ID of the document to update.

header Parameters
x-company
integer <int32>

ID of the company.

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

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Updates the binary file of an existing document using base64.

Allows updating the binary file of an existing document by sending the file in base64.

Authorizations:
oauth2
path Parameters
id
required
integer <int32>

ID of the document to update.

header Parameters
x-company
integer <int32>

ID of the company.

Request Body schema: application/json

Payload with the binary in base64 and the file name.

fileName
required
string non-empty

Name of the file to be updated.

document
required
string non-empty

Document content encoded in base64.

Responses

Request samples

Content type
application/json
{
  • "fileName": "string",
  • "document": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Get binary document record for a specific company.

This operation allows you to retrieve binary document record based on the id, and it returns a response based on the status of the operation.

Authorizations:
oauth2
path Parameters
documentId
required
integer <int32>

The identifier of the document for which to retrieve document record.

header Parameters
x-company
integer <int32>

The identifier of the company for which to retrieve document record.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Creates a new documents records for a specific company using the provided payload, processed asynchronously via Azure Function.

Same as CreateDocuments but processed asynchronously via Azure Function.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the document is being created.

x-referenceField
string

The reference of the field for search

Request Body schema: multipart/form-data
documents
required
Array of strings <binary> [ items <binary > ]

The list of document file instances representing the document files.

shipmentIds
Array of integers <int32> [ items <int32 > ]

The list of shipment IDs for the documents.

referenceFieldValue
string

The value of ReferenceFieldHeader for the documents.

documentTypes
required
Array of integers <int32> [ items <int32 > ]

The list of document types corresponding to the documents.

replace
boolean

Bool if must replace the document if alredy exists (false by default)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Update a document record in batch mode for a specific company using the provided payload.

This operation updates a document record in batch mode. It can use Azure Function depending on configuration settings.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

ID of the company.

Request Body schema: application/json

Payload containing information for updating the document.

id
required
integer <int32>

The ID of the document to be updated.

shipmentId
required
integer <int32>

The shipment ID associated with the document.

documentTypeId
required
integer <int32>

The document type ID associated with the document.

filename
string or null

The document name.

createdBy
string or null

The user who created the document.

createdOn
string <date-time>

The date and time when the document was created.

modifiedBy
string or null

The user who last modified the document.

modifiedOn
string <date-time>

The date and time when the document was last modified.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "shipmentId": 0,
  • "documentTypeId": 0,
  • "filename": "string",
  • "createdBy": "string",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "modifiedBy": "string",
  • "modifiedOn": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Delete document records in batch mode for a specific company.

This operation allows you to delete document records in batch mode, optionally using Azure Functions for asynchronous processing.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the documents are being deleted.

Request Body schema: application/json

The payload containing document ids.

ids
required
Array of integers <int32> [ items <int32 > ]

A ids of documents to delete

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Mappers

Get map agent records.

This operation allows you to retrieve map agent records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get map carrier records.

This operation allows you to retrieve map carrier records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get map commodity records.

This operation allows you to retrieve map commodity records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get map container type records.

This operation allows you to retrieve map container type records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get map country records.

This operation allows you to retrieve map country records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get map incoterm records.

This operation allows you to retrieve map incoterm records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get map package type records.

This operation allows you to retrieve map package type records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get map project records.

This operation allows you to retrieve map project records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Get map terminal records.

This operation allows you to retrieve map terminal records, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Shipments

Creates a new shipment record for a specific company.

This operation allows you to add a shipment with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the shipment is being created.

Request Body schema: application/json

The payload containing shipment details.

Array of objects or null (CreateShipmentContainerPayload)

A collection of containers associated with the shipment.

customerRef
string or null

The customer reference.

shipper
string or null

The shipper name.

shipperRef
string or null

The shipper reference.

consignee
string or null

The consignee name.

consigneeRef
string or null

The consignee reference.

client
string or null

The client name.

shipmentType
string (ShipmentType)
Enum: "AIR" "FCL" "LCL" "LND" "GEN" "SOL"

Represents the type of a shipment, which can be one of the following values: AIR, LND, LCL, FCL.

polLocode
string or null

The origin port LOCODE.

podLocode
string or null

The destination port LOCODE.

polUserLocode
string or null

The origin port LOCODE user.

podUserLocode
string or null

The destination port LOCODE user.

originVehicle
string or null

The origin vehicle.

destinationVehicle
string or null

The destination vehicle.

mbl
string or null

The Master Bill of Lading (MBL).

hbl
string or null

The House Bill of Lading (HBL).

awb
string or null

The Air Waybill (AWB).

hawb
string or null

The House Air Waybill (HAWB).

booking
string or null

The booking reference.

shippingLine
string or null

The shipping line name.

shippingLineSCAC
string or null

The shipping line SCAC.

airline
string or null

The air line name.

deliveryLocation
string or null

The delivery location.

incoterm
string or null

The Incoterm for the shipment.

project
string or null

The project associated with the shipment.

voyageNumber
string or null

The voyage number.

forwarder
string or null

The forwarder name.

forwarderRef
string or null

The forwarder reference.

originCustoms
string or null

The origin customs office.

originCustomsRef
string or null

The reference for the origin customs office.

destinationCustomsRef
string or null

The reference for the destination customs office.

truckSupplier
string or null

The truck supplier name.

truckSupplierRef
string or null

The reference for the truck supplier.

destinationCustoms
string or null

The reference for the destination customs

status
string or null

The status name.

integrationStatus
string or null

The integration status name.

createdOn
string <date-time>

The timestamp when the entity was created.

relatedRef
string or null

The reference for the shipment with relation of this

relatedOrder
integer <int32>

Order of the relation in the list

Responses

Request samples

Content type
application/json
{
  • "containers": [
    ],
  • "customerRef": "string",
  • "shipper": "string",
  • "shipperRef": "string",
  • "consignee": "string",
  • "consigneeRef": "string",
  • "client": "string",
  • "shipmentType": "AIR",
  • "polLocode": "string",
  • "podLocode": "string",
  • "polUserLocode": "string",
  • "podUserLocode": "string",
  • "originVehicle": "string",
  • "destinationVehicle": "string",
  • "mbl": "string",
  • "hbl": "string",
  • "awb": "string",
  • "hawb": "string",
  • "booking": "string",
  • "shippingLine": "string",
  • "shippingLineSCAC": "string",
  • "airline": "string",
  • "deliveryLocation": "string",
  • "incoterm": "string",
  • "project": "string",
  • "voyageNumber": "string",
  • "forwarder": "string",
  • "forwarderRef": "string",
  • "originCustoms": "string",
  • "originCustomsRef": "string",
  • "destinationCustomsRef": "string",
  • "truckSupplier": "string",
  • "truckSupplierRef": "string",
  • "destinationCustoms": "string",
  • "status": "string",
  • "integrationStatus": "string",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "relatedRef": "string",
  • "relatedOrder": 0
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Update a shipment record for a specific company.

This operation allows you to update a shipment with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the shipment is being updated.

x-referenceField
string

The reference of the field for search

Request Body schema: application/json

The payload containing shipment details.

id
integer <int32>

Id of Shipment. Optional for upsert logic; when 0, other references may be used.

Array of objects or null (UpdateShipmentContainerPayload)

A collection of containers associated with the shipment.

customerRef
string or null

The customer reference.

shipper
string or null

The shipper name.

shipperRef
string or null

The shipper reference.

consignee
string or null

The consignee name.

consigneeRef
string or null

The consignee reference.

client
string or null

The client name.

shipmentType
string (ShipmentType)
Enum: "AIR" "FCL" "LCL" "LND" "GEN" "SOL"

Represents the type of a shipment, which can be one of the following values: AIR, LND, LCL, FCL.

polLocode
string or null

The origin port LOCODE.

podLocode
string or null

The destination port LOCODE.

polUserLocode
string or null

The origin port LOCODE user.

podUserLocode
string or null

The destination port LOCODE user.

originVehicle
string or null

The origin vehicle.

destinationVehicle
string or null

The destination vehicle.

mbl
string or null

The Master Bill of Lading (MBL).

hbl
string or null

The House Bill of Lading (HBL).

awb
string or null

The Air Waybill (AWB).

hawb
string or null

The House Air Waybill (HAWB).

booking
string or null

The booking reference.

shippingLine
string or null

The shipping line name.

shippingLineSCAC
string or null

The shipping line SCAC.

airline
string or null

The air line name.

deliveryLocation
string or null

The delivery location.

incoterm
string or null

The Incoterm for the shipment.

project
string or null

The project associated with the shipment.

voyageNumber
string or null

The voyage number.

forwarder
string or null

The forwarder name.

forwarderRef
string or null

The forwarder reference.

originCustoms
string or null

The origin customs office.

originCustomsRef
string or null

The reference for the origin customs office.

destinationCustomsRef
string or null

The reference for the destination customs office.

truckSupplier
string or null

The truck supplier name.

truckSupplierRef
string or null

The reference for the truck supplier.

destinationCustoms
string or null

The reference for the destination customs

status
string or null

The status name.

integrationStatus
string or null

The integration status name.

createdOn
string <date-time>

The timestamp when the entity was created.

relatedRef
string or null

The reference for the shipment with relation of this

relatedOrder
integer <int32>

Order of the relation in the list

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "containers": [
    ],
  • "customerRef": "string",
  • "shipper": "string",
  • "shipperRef": "string",
  • "consignee": "string",
  • "consigneeRef": "string",
  • "client": "string",
  • "shipmentType": "AIR",
  • "polLocode": "string",
  • "podLocode": "string",
  • "polUserLocode": "string",
  • "podUserLocode": "string",
  • "originVehicle": "string",
  • "destinationVehicle": "string",
  • "mbl": "string",
  • "hbl": "string",
  • "awb": "string",
  • "hawb": "string",
  • "booking": "string",
  • "shippingLine": "string",
  • "shippingLineSCAC": "string",
  • "airline": "string",
  • "deliveryLocation": "string",
  • "incoterm": "string",
  • "project": "string",
  • "voyageNumber": "string",
  • "forwarder": "string",
  • "forwarderRef": "string",
  • "originCustoms": "string",
  • "originCustomsRef": "string",
  • "destinationCustomsRef": "string",
  • "truckSupplier": "string",
  • "truckSupplierRef": "string",
  • "destinationCustoms": "string",
  • "status": "string",
  • "integrationStatus": "string",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "relatedRef": "string",
  • "relatedOrder": 0
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Delete a shipments records for a specific company.

This operation allows you to delete a shipments with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the shipments are being deleted.

Request Body schema: application/json

The payload containing shipments ids.

ids
Array of integers or null <int32>

A ids of Shipments to delete

customerRefs
Array of strings or null

CustomerRefs of Shipments to delete

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "customerRefs": [
    ]
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Get shipment records for a specific company.

This operation allows you to retrieve shipment records based on the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

The identifier of the company for which to retrieve shipment records.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Create or update a shipment: updates if exists by reference, otherwise creates it.

If the shipment exists, it will be updated; otherwise, it will be created.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

Company identifier.

x-referenceField
string

Optional reference field to search (e.g. ID, CustomerRef). If omitted, payload Id/CustomerRef will be used.

Request Body schema: application/json

The payload containing shipment details for update or create.

id
integer or null <int32>

Id of Shipment. Optional for upsert logic; when null, a new shipment will be created.

createdOn
string or null <date-time>

The timestamp when the entity was created.

Array of objects or null (UpdateShipmentContainerPayload)

A collection of containers associated with the shipment.

customerRef
string or null

The customer reference.

shipper
string or null

The shipper name.

shipperRef
string or null

The shipper reference.

consignee
string or null

The consignee name.

consigneeRef
string or null

The consignee reference.

client
string or null

The client name.

shipmentType
string (ShipmentType)
Enum: "AIR" "FCL" "LCL" "LND" "GEN" "SOL"

Represents the type of a shipment, which can be one of the following values: AIR, LND, LCL, FCL.

polLocode
string or null

The origin port LOCODE.

podLocode
string or null

The destination port LOCODE.

polUserLocode
string or null

The origin port LOCODE user.

podUserLocode
string or null

The destination port LOCODE user.

originVehicle
string or null

The origin vehicle.

destinationVehicle
string or null

The destination vehicle.

mbl
string or null

The Master Bill of Lading (MBL).

hbl
string or null

The House Bill of Lading (HBL).

awb
string or null

The Air Waybill (AWB).

hawb
string or null

The House Air Waybill (HAWB).

booking
string or null

The booking reference.

shippingLine
string or null

The shipping line name.

shippingLineSCAC
string or null

The shipping line SCAC.

airline
string or null

The air line name.

deliveryLocation
string or null

The delivery location.

incoterm
string or null

The Incoterm for the shipment.

project
string or null

The project associated with the shipment.

voyageNumber
string or null

The voyage number.

forwarder
string or null

The forwarder name.

forwarderRef
string or null

The forwarder reference.

originCustoms
string or null

The origin customs office.

originCustomsRef
string or null

The reference for the origin customs office.

destinationCustomsRef
string or null

The reference for the destination customs office.

truckSupplier
string or null

The truck supplier name.

truckSupplierRef
string or null

The reference for the truck supplier.

destinationCustoms
string or null

The reference for the destination customs

status
string or null

The status name.

integrationStatus
string or null

The integration status name.

relatedRef
string or null

The reference for the shipment with relation of this

relatedOrder
integer <int32>

Order of the relation in the list

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "createdOn": "2019-08-24T14:15:22Z",
  • "containers": [
    ],
  • "customerRef": "string",
  • "shipper": "string",
  • "shipperRef": "string",
  • "consignee": "string",
  • "consigneeRef": "string",
  • "client": "string",
  • "shipmentType": "AIR",
  • "polLocode": "string",
  • "podLocode": "string",
  • "polUserLocode": "string",
  • "podUserLocode": "string",
  • "originVehicle": "string",
  • "destinationVehicle": "string",
  • "mbl": "string",
  • "hbl": "string",
  • "awb": "string",
  • "hawb": "string",
  • "booking": "string",
  • "shippingLine": "string",
  • "shippingLineSCAC": "string",
  • "airline": "string",
  • "deliveryLocation": "string",
  • "incoterm": "string",
  • "project": "string",
  • "voyageNumber": "string",
  • "forwarder": "string",
  • "forwarderRef": "string",
  • "originCustoms": "string",
  • "originCustomsRef": "string",
  • "destinationCustomsRef": "string",
  • "truckSupplier": "string",
  • "truckSupplierRef": "string",
  • "destinationCustoms": "string",
  • "status": "string",
  • "integrationStatus": "string",
  • "relatedRef": "string",
  • "relatedOrder": 0
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Create or update a shipment in batch: updates if exists by reference, otherwise creates it.

If the shipment exists, it will be updated; otherwise, it will be created. Processed via batch/queue when enabled.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

Company identifier.

x-referenceField
string

Optional reference field to search (e.g. ID, CustomerRef). If omitted, payload Id/CustomerRef will be used.

Request Body schema: application/json

The payload containing shipment details for update or create.

id
integer or null <int32>

Id of Shipment. Optional for upsert logic; when null, a new shipment will be created.

createdOn
string or null <date-time>

The timestamp when the entity was created.

Array of objects or null (UpdateShipmentContainerPayload)

A collection of containers associated with the shipment.

customerRef
string or null

The customer reference.

shipper
string or null

The shipper name.

shipperRef
string or null

The shipper reference.

consignee
string or null

The consignee name.

consigneeRef
string or null

The consignee reference.

client
string or null

The client name.

shipmentType
string (ShipmentType)
Enum: "AIR" "FCL" "LCL" "LND" "GEN" "SOL"

Represents the type of a shipment, which can be one of the following values: AIR, LND, LCL, FCL.

polLocode
string or null

The origin port LOCODE.

podLocode
string or null

The destination port LOCODE.

polUserLocode
string or null

The origin port LOCODE user.

podUserLocode
string or null

The destination port LOCODE user.

originVehicle
string or null

The origin vehicle.

destinationVehicle
string or null

The destination vehicle.

mbl
string or null

The Master Bill of Lading (MBL).

hbl
string or null

The House Bill of Lading (HBL).

awb
string or null

The Air Waybill (AWB).

hawb
string or null

The House Air Waybill (HAWB).

booking
string or null

The booking reference.

shippingLine
string or null

The shipping line name.

shippingLineSCAC
string or null

The shipping line SCAC.

airline
string or null

The air line name.

deliveryLocation
string or null

The delivery location.

incoterm
string or null

The Incoterm for the shipment.

project
string or null

The project associated with the shipment.

voyageNumber
string or null

The voyage number.

forwarder
string or null

The forwarder name.

forwarderRef
string or null

The forwarder reference.

originCustoms
string or null

The origin customs office.

originCustomsRef
string or null

The reference for the origin customs office.

destinationCustomsRef
string or null

The reference for the destination customs office.

truckSupplier
string or null

The truck supplier name.

truckSupplierRef
string or null

The reference for the truck supplier.

destinationCustoms
string or null

The reference for the destination customs

status
string or null

The status name.

integrationStatus
string or null

The integration status name.

relatedRef
string or null

The reference for the shipment with relation of this

relatedOrder
integer <int32>

Order of the relation in the list

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "createdOn": "2019-08-24T14:15:22Z",
  • "containers": [
    ],
  • "customerRef": "string",
  • "shipper": "string",
  • "shipperRef": "string",
  • "consignee": "string",
  • "consigneeRef": "string",
  • "client": "string",
  • "shipmentType": "AIR",
  • "polLocode": "string",
  • "podLocode": "string",
  • "polUserLocode": "string",
  • "podUserLocode": "string",
  • "originVehicle": "string",
  • "destinationVehicle": "string",
  • "mbl": "string",
  • "hbl": "string",
  • "awb": "string",
  • "hawb": "string",
  • "booking": "string",
  • "shippingLine": "string",
  • "shippingLineSCAC": "string",
  • "airline": "string",
  • "deliveryLocation": "string",
  • "incoterm": "string",
  • "project": "string",
  • "voyageNumber": "string",
  • "forwarder": "string",
  • "forwarderRef": "string",
  • "originCustoms": "string",
  • "originCustomsRef": "string",
  • "destinationCustomsRef": "string",
  • "truckSupplier": "string",
  • "truckSupplierRef": "string",
  • "destinationCustoms": "string",
  • "status": "string",
  • "integrationStatus": "string",
  • "relatedRef": "string",
  • "relatedOrder": 0
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Creates a new shipment record for a specific company.

This operation allows you to add a shipment with the provided payload, and it returns a response with the status URL of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the shipment is being created.

Request Body schema: application/json

The payload containing shipment details.

Array of objects or null (CreateShipmentContainerPayload)

A collection of containers associated with the shipment.

customerRef
string or null

The customer reference.

shipper
string or null

The shipper name.

shipperRef
string or null

The shipper reference.

consignee
string or null

The consignee name.

consigneeRef
string or null

The consignee reference.

client
string or null

The client name.

shipmentType
string (ShipmentType)
Enum: "AIR" "FCL" "LCL" "LND" "GEN" "SOL"

Represents the type of a shipment, which can be one of the following values: AIR, LND, LCL, FCL.

polLocode
string or null

The origin port LOCODE.

podLocode
string or null

The destination port LOCODE.

polUserLocode
string or null

The origin port LOCODE user.

podUserLocode
string or null

The destination port LOCODE user.

originVehicle
string or null

The origin vehicle.

destinationVehicle
string or null

The destination vehicle.

mbl
string or null

The Master Bill of Lading (MBL).

hbl
string or null

The House Bill of Lading (HBL).

awb
string or null

The Air Waybill (AWB).

hawb
string or null

The House Air Waybill (HAWB).

booking
string or null

The booking reference.

shippingLine
string or null

The shipping line name.

shippingLineSCAC
string or null

The shipping line SCAC.

airline
string or null

The air line name.

deliveryLocation
string or null

The delivery location.

incoterm
string or null

The Incoterm for the shipment.

project
string or null

The project associated with the shipment.

voyageNumber
string or null

The voyage number.

forwarder
string or null

The forwarder name.

forwarderRef
string or null

The forwarder reference.

originCustoms
string or null

The origin customs office.

originCustomsRef
string or null

The reference for the origin customs office.

destinationCustomsRef
string or null

The reference for the destination customs office.

truckSupplier
string or null

The truck supplier name.

truckSupplierRef
string or null

The reference for the truck supplier.

destinationCustoms
string or null

The reference for the destination customs

status
string or null

The status name.

integrationStatus
string or null

The integration status name.

createdOn
string <date-time>

The timestamp when the entity was created.

relatedRef
string or null

The reference for the shipment with relation of this

relatedOrder
integer <int32>

Order of the relation in the list

Responses

Request samples

Content type
application/json
{
  • "containers": [
    ],
  • "customerRef": "string",
  • "shipper": "string",
  • "shipperRef": "string",
  • "consignee": "string",
  • "consigneeRef": "string",
  • "client": "string",
  • "shipmentType": "AIR",
  • "polLocode": "string",
  • "podLocode": "string",
  • "polUserLocode": "string",
  • "podUserLocode": "string",
  • "originVehicle": "string",
  • "destinationVehicle": "string",
  • "mbl": "string",
  • "hbl": "string",
  • "awb": "string",
  • "hawb": "string",
  • "booking": "string",
  • "shippingLine": "string",
  • "shippingLineSCAC": "string",
  • "airline": "string",
  • "deliveryLocation": "string",
  • "incoterm": "string",
  • "project": "string",
  • "voyageNumber": "string",
  • "forwarder": "string",
  • "forwarderRef": "string",
  • "originCustoms": "string",
  • "originCustomsRef": "string",
  • "destinationCustomsRef": "string",
  • "truckSupplier": "string",
  • "truckSupplierRef": "string",
  • "destinationCustoms": "string",
  • "status": "string",
  • "integrationStatus": "string",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "relatedRef": "string",
  • "relatedOrder": 0
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Update a shipment record for a specific company.

This operation allows you to update a shipment with the provided payload, and it returns a response with the status URL of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the shipment is being updated.

x-referenceField
string

The reference of the field for search

Request Body schema: application/json

The payload containing shipment details.

id
integer <int32>

Id of Shipment. Optional for upsert logic; when 0, other references may be used.

Array of objects or null (UpdateShipmentContainerPayload)

A collection of containers associated with the shipment.

customerRef
string or null

The customer reference.

shipper
string or null

The shipper name.

shipperRef
string or null

The shipper reference.

consignee
string or null

The consignee name.

consigneeRef
string or null

The consignee reference.

client
string or null

The client name.

shipmentType
string (ShipmentType)
Enum: "AIR" "FCL" "LCL" "LND" "GEN" "SOL"

Represents the type of a shipment, which can be one of the following values: AIR, LND, LCL, FCL.

polLocode
string or null

The origin port LOCODE.

podLocode
string or null

The destination port LOCODE.

polUserLocode
string or null

The origin port LOCODE user.

podUserLocode
string or null

The destination port LOCODE user.

originVehicle
string or null

The origin vehicle.

destinationVehicle
string or null

The destination vehicle.

mbl
string or null

The Master Bill of Lading (MBL).

hbl
string or null

The House Bill of Lading (HBL).

awb
string or null

The Air Waybill (AWB).

hawb
string or null

The House Air Waybill (HAWB).

booking
string or null

The booking reference.

shippingLine
string or null

The shipping line name.

shippingLineSCAC
string or null

The shipping line SCAC.

airline
string or null

The air line name.

deliveryLocation
string or null

The delivery location.

incoterm
string or null

The Incoterm for the shipment.

project
string or null

The project associated with the shipment.

voyageNumber
string or null

The voyage number.

forwarder
string or null

The forwarder name.

forwarderRef
string or null

The forwarder reference.

originCustoms
string or null

The origin customs office.

originCustomsRef
string or null

The reference for the origin customs office.

destinationCustomsRef
string or null

The reference for the destination customs office.

truckSupplier
string or null

The truck supplier name.

truckSupplierRef
string or null

The reference for the truck supplier.

destinationCustoms
string or null

The reference for the destination customs

status
string or null

The status name.

integrationStatus
string or null

The integration status name.

createdOn
string <date-time>

The timestamp when the entity was created.

relatedRef
string or null

The reference for the shipment with relation of this

relatedOrder
integer <int32>

Order of the relation in the list

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "containers": [
    ],
  • "customerRef": "string",
  • "shipper": "string",
  • "shipperRef": "string",
  • "consignee": "string",
  • "consigneeRef": "string",
  • "client": "string",
  • "shipmentType": "AIR",
  • "polLocode": "string",
  • "podLocode": "string",
  • "polUserLocode": "string",
  • "podUserLocode": "string",
  • "originVehicle": "string",
  • "destinationVehicle": "string",
  • "mbl": "string",
  • "hbl": "string",
  • "awb": "string",
  • "hawb": "string",
  • "booking": "string",
  • "shippingLine": "string",
  • "shippingLineSCAC": "string",
  • "airline": "string",
  • "deliveryLocation": "string",
  • "incoterm": "string",
  • "project": "string",
  • "voyageNumber": "string",
  • "forwarder": "string",
  • "forwarderRef": "string",
  • "originCustoms": "string",
  • "originCustomsRef": "string",
  • "destinationCustomsRef": "string",
  • "truckSupplier": "string",
  • "truckSupplierRef": "string",
  • "destinationCustoms": "string",
  • "status": "string",
  • "integrationStatus": "string",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "relatedRef": "string",
  • "relatedOrder": 0
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Delete a shipments records for a specific company.

This operation allows you to delete a shipments with the provided payload, and it returns a response with the status URL of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the shipments are being deleted.

Request Body schema: application/json

The payload containing shipments ids.

ids
Array of integers or null <int32>

A ids of Shipments to delete

customerRefs
Array of strings or null

CustomerRefs of Shipments to delete

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "customerRefs": [
    ]
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Tag

Creates a new tag record for a specific company.

This operation allows you to add a tag with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the tag is being created.

Request Body schema: application/json

The payload containing tag details.

required
Array of objects (TagPayload)

The list of tags to be created.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Update a tag record for a specific company.

This operation allows you to update a tag with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the tag is being updated.

Request Body schema: application/json

The payload containing tag details.

required
Array of objects (UpdateTagItem)

Gets or sets the list of tags to update.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Delete a tag records for a specific company.

This operation allows you to delete a tag with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the tag are being deleted.

Request Body schema: application/json

The payload containing tag ids.

tagIds
Array of integers or null <int32>

The list of tags to be deleted.

tagNames
Array of strings or null

The list of tags to be deleted.

Responses

Request samples

Content type
application/json
{
  • "tagIds": [
    ],
  • "tagNames": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Get trackers records for a specific company.

This operation allows you to retrieve trackers records based on the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

The identifier of the company for which to retrieve trackers records.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Assigns a tag to a specific shipment.

This operation allows you to assign a tag to a specific shipment, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the tag is being assigned.

Request Body schema: application/json

The payload containing tag and shipment information.

tagId
integer or null <int32>

The id of the tag to assign.

tagName
string or null

The name of the tag to assign.

shipmentId
required
integer <int32>

The ID of the shipment to which the tag should be assigned.

Responses

Request samples

Content type
application/json
{
  • "tagId": 0,
  • "tagName": "string",
  • "shipmentId": 0
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Unassigns a tag from a specific shipment.

This operation allows you to unassign a tag from a specific shipment, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the tag is being unassigned.

Request Body schema: application/json

The payload containing tag and shipment information.

tagName
string or null

The name of the tag to unassign.

tagId
integer or null <int32>

The id of the tag to unassign.

shipmentId
required
integer <int32>

The ID of the shipment from which the tag should be unassigned.

Responses

Request samples

Content type
application/json
{
  • "tagName": "string",
  • "tagId": 0,
  • "shipmentId": 0
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Trackers

Creates a new tracker record for a specific company.

This operation allows you to add a trackers with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the tracker is being created.

Request Body schema: application/json

The payload containing tracker details.

required
Array of objects (TrackerPayload)

The list of tracker payloads associated with the create request.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Update a trackers record for a specific company.

This operation allows you to update a trackers with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the tracker is being updated.

Request Body schema: application/json

The payload containing tracker details.

required
Array of objects (TrackerPayload)

The list of tracker payloads associated with the update request.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Delete a trackers records for a specific company.

This operation allows you to delete a trackers with the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the trackers are being deleted.

Request Body schema: application/json

The payload containing trackers ids.

trackerNames
required
Array of strings

A ids of trackers to delete

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Get trackers records for a specific company.

This operation allows you to retrieve trackers records based on the provided payload, and it returns a response based on the status of the operation.

Authorizations:
oauth2
query Parameters
startRow
required
integer <int32>

The first row index to get.

endRow
required
integer <int32>

The last row index to get.

sortDirection
required
string

Sort direction to order by ascending or descending. Available values: asc/desc

sortProperty
required
string

Indicate property to sort data. All properties are in the example response

filterProperty
string

Indicate property to filter data by one only column.

filterValue
string

Set value to filter data

Array of objects (IInfiniteRowFilterPayload)

Set list of filter data

header Parameters
x-company
integer <int32>

The identifier of the company for which to retrieve trackers records.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0,
  • "message": "string"
}

Creates a new tracker record for a specific company.

This operation allows you to add a trackers with the provided payload, and it returns a response with the status URL of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the tracker is being created.

Request Body schema: application/json

The payload containing tracker details.

required
Array of objects (TrackerPayload)

The list of tracker payloads associated with the create request.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Update a trackers record for a specific company.

This operation allows you to update a trackers with the provided payload, and it returns a response with the status URL of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the tracker is being updated.

Request Body schema: application/json

The payload containing tracker details.

required
Array of objects (TrackerPayload)

The list of tracker payloads associated with the update request.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Delete a trackers records for a specific company.

This operation allows you to delete a trackers with the provided payload, and it returns a response with the status URL of the operation.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

The identifier of the company for which the trackers are being deleted.

Request Body schema: application/json

The payload containing trackers ids.

trackerNames
required
Array of strings

A ids of trackers to delete

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

UserCompanies

Lists the users associated with a company.

Gets the list of users associated with a company.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0,
  • "message": "string"
}

Adds a user to a company.

Allows you to add a user to a company.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>
Request Body schema: application/json
userEmail
Array of strings or null

List of user email addresses to add or remove from the company.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}

Removes a user from a company.

Allows you to remove a user from a company.

Authorizations:
oauth2
header Parameters
x-company
integer <int32>
Request Body schema: application/json
userEmail
Array of strings or null

List of user email addresses to add or remove from the company.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string"
}