Skip to main content
API docs by Redocly

Flowls API Documentation (1.0)

Download OpenAPI specification:Download

Order

Endpoints for retrieving, managing, and interacting with an Operation's orders.

Delete an Order

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

id
required
integer
Example: 100

Order ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Get an Order

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

id
required
integer
Example: 100

Order ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Update an Order

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

id
required
integer
Example: 100

Order ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

The attributes to Update an Order

object
external_reference_code
string or null

An external reference code associated with the Order.

object

Handlers responsible for managing this Process by Role.

Array of objects (NestedUpdateHandlerParams)
Deprecated

An array of Handlers responsible for managing this Order.

observations
string or null

Textual field for recording observations or comments related to the PO.

object

A Purchase Order (PO) associated with this Order.

object

A Sales Order (SO) associated with this Order.

subsidiary_id
integer or null

Unique identifier for the Subsidiary.

Responses

Request samples

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

Response samples

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

Cancel an Order

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

id
required
integer
Example: 100

Order ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Uncancel an Order by Reference Code

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: ORC-01

Reference Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Cancel an Order by Reference Code

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: ORC-01

Reference Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Uncancel an Order

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

id
required
integer
Example: 100

Order ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Finish an Order by Reference Code

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: ORC-01

Reference Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Delete an Order by Reference Code

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: ORC-01

Reference Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Get an Order by Reference Code

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: ORC-01

Reference Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Update an Order by Reference Code

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: ORC-01

Reference Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

The attributes to Update an Order

object
external_reference_code
string or null

An external reference code associated with the Order.

object

Handlers responsible for managing this Process by Role.

Array of objects (NestedUpdateHandlerParams)
Deprecated

An array of Handlers responsible for managing this Order.

observations
string or null

Textual field for recording observations or comments related to the PO.

object

A Purchase Order (PO) associated with this Order.

object

A Sales Order (SO) associated with this Order.

subsidiary_id
integer or null

Unique identifier for the Subsidiary.

Responses

Request samples

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

Response samples

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

Finish an Order

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

id
required
integer
Example: 100

Order ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

List Orders of an Operation

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

query Parameters
object

Parameter for controlling pagination of the result set.

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Create an Order

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

The attributes to Create an Order

object
external_reference_code
string or null

An external reference code associated with the Order.

object

Handlers responsible for managing this Process by Role.

Array of objects (NestedCreateHandlerParams)
Deprecated

An array of Handlers responsible for managing this Order.

observations
string or null

Textual field for recording observations or comments related to the PO.

object

A Purchase Order (PO) associated with this Order.

reference_code
string or null

A reference code associated with the Order.

object

A Sales Order (SO) associated with this Order.

subsidiary_id
integer or null

Unique identifier for the Subsidiary.

Responses

Request samples

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

Response samples

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

Upsert an Order

Create new entries if they don't exist, and update existing entries if they do, using the reference_code as key.

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

The attributes to Create/Update a Orders

Array of objects
Array
external_reference_code
string or null

An external reference code associated with the Order.

object

Handlers responsible for managing this Process by Role.

Array of objects (NestedUpdateHandlerParams)
Deprecated

An array of Handlers responsible for managing this Order.

observations
string or null

Textual field for recording observations or comments related to the PO.

object

A Purchase Order (PO) associated with this Order.

reference_code
required
string

A reference code of the Order. This is the key used to check whether the order should be updated or created.

object

A Sales Order (SO) associated with this Order.

subsidiary_id
integer or null

Unique identifier for the Subsidiary.

Responses

Request samples

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

Response samples

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

Process

Endpoints for retrieving, managing, and interacting with an Operation's processes.

Uncancel a Process by Reference Code

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: PRC-01

Reference Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Delete a Process by Reference Code

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: PRC-01

Reference Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Get a Process by Reference Code

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: PRC-01

Reference Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Update a Process by Reference Code

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: PRC-01

Reference Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

The attributes to Update a Process

object
alert_level
string
Default: "NORMAL"
Enum: "WARNING" "DANGER" "NORMAL"

Alert level indicating the severity of the Process.

brazilian_invoices
Array of strings

An array of Brazilian Invoice XML files as Base64.

cost_model_version_id
integer or null

A Cost Model associated with this Process.

object or null

A Foreign Trade Shipment associated with this Process.

object

Handlers responsible for managing this Process by Role.

Array of objects (NestedUpdateHandlerParams)
Deprecated

An array of Handlers responsible for managing this Process.

lead_time_datetime_reference
string or null <date-time>

The timestamp serving as the reference point for lead time calculations. Format: ISO 8601 'date-time'.

order_ids
Array of integers

An array of Order IDs associated with this Process. As an alternative, you can also use order_reference_codes

order_reference_codes
Array of strings

An array of Order Reference Codes associated with this Process. As an alternative, you can also use order_ids

Responses

Request samples

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

Response samples

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

Cancel a Process

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

id
required
integer
Example: 100

Process ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Uncancel a Process

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

id
required
integer
Example: 100

Process ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Delete a Process

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

id
required
integer
Example: 100

Process ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Get a Process

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

id
required
integer
Example: 100

Process ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Update a Process

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

id
required
integer
Example: 100

Process ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

The attributes to Update a Process

object
alert_level
string
Default: "NORMAL"
Enum: "WARNING" "DANGER" "NORMAL"

Alert level indicating the severity of the Process.

brazilian_invoices
Array of strings

An array of Brazilian Invoice XML files as Base64.

cost_model_version_id
integer or null

A Cost Model associated with this Process.

object or null

A Foreign Trade Shipment associated with this Process.

object

Handlers responsible for managing this Process by Role.

Array of objects (NestedUpdateHandlerParams)
Deprecated

An array of Handlers responsible for managing this Process.

lead_time_datetime_reference
string or null <date-time>

The timestamp serving as the reference point for lead time calculations. Format: ISO 8601 'date-time'.

order_ids
Array of integers

An array of Order IDs associated with this Process. As an alternative, you can also use order_reference_codes

order_reference_codes
Array of strings

An array of Order Reference Codes associated with this Process. As an alternative, you can also use order_ids

Responses

Request samples

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

Response samples

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

Cancel a Process by Reference Code

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: PRC-01

Reference Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Finish a Process by Reference Code

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: PRC-01

Reference Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

List Processes of an Operation

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

query Parameters
object

Parameter for controlling pagination of the result set.

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Create a Process

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

The attributes to Create a Process

object
alert_level
string
Default: "NORMAL"
Enum: "WARNING" "DANGER" "NORMAL"

Alert level indicating the severity of the Process.

brazilian_invoices
Array of strings

An array of Brazilian Invoice XML files as Base64.

cost_model_version_id
integer or null

A Cost Model Version associated with this Process.

object or null

A Foreign Trade Shipment associated with this Process.

object

Handlers responsible for managing this Process by Role.

Array of objects (NestedCreateHandlerParams)
Deprecated

An array of Handlers responsible for managing this Process.

lead_time_datetime_reference
string or null <date-time>

The timestamp serving as the reference point for lead time calculations. Format: ISO 8601 'date-time'.

order_ids
Array of integers

An array of Order IDs associated with this Process. As an alternative, you can also use order_reference_codes

order_reference_codes
Array of strings

An array of Order Reference Codes associated with this Process. As an alternative, you can also use order_ids

reference_code
string or null

A reference code associated with the Process.

Responses

Request samples

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

Response samples

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

Upsert a Process

Create new entries if they don't exist, and update existing entries if they do, using the reference_code as key.

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

The attributes to Create/Update a Processes

Array of objects
Array
alert_level
string
Default: "NORMAL"
Enum: "WARNING" "DANGER" "NORMAL"

Alert level indicating the severity of the Process.

brazilian_invoices
Array of strings

An array of Brazilian Invoice XML files as Base64.

cost_model_version_id
integer or null

A Cost Model associated with this Process.

object or null

A Foreign Trade Shipment associated with this Process.

object

Handlers responsible for managing this Process by Role.

Array of objects (NestedUpdateHandlerParams)
Deprecated

An array of Handlers responsible for managing this Process.

lead_time_datetime_reference
string or null <date-time>

The timestamp serving as the reference point for lead time calculations. Format: ISO 8601 'date-time'.

order_ids
Array of integers

An array of Order IDs associated with this Process. As an alternative, you can also use order_reference_codes

order_reference_codes
Array of strings

An array of Order Reference Codes associated with this Process. As an alternative, you can also use order_ids

reference_code
required
string

A reference code of the Process. This is the key used to check whether the process should be updated or created.

Responses

Request samples

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

Response samples

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

Finish a Process

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

id
required
integer
Example: 100

Process ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Product

Endpoints for retrieving, managing, and interacting with Products.

List Products

Authorizations:
api-key
query Parameters
object

Parameter for controlling pagination of the result set.

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Create a Product

Authorizations:
api-key
header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

The attributes to Create a Product

multiple_package_per_container_ft20
integer or null

Estimated number of packages fitting by volume (cubage) in a 20ft container.

category
string or null

Category of the product.

package_measurement_unit
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Package Measurement Unit of the product.

extra
json or null

Extra information related to the product.

package_capacity
string or null <decimal>

Package capacity of the product.

multiple_package_type
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Type of the multi-package unit (e.g. box, pallet, bag).

family
string or null

Family of the product.

pallets_per_container_ft40
integer or null

Estimated number of pallets that fit into a 40ft container.

has_unitization
boolean or null

If Product has Unitization

code
string

Code (SKU) of the product.

translated_descriptions
json or null

Translated descriptions related to the product.

manufacturer
string or null

Manufacturer of the product.

multiple_package_measurement_unit
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Multiple Package Measurement Unit of the product.

has_containerization
boolean or null

If Product has Containerization

package_type
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Package Type of the product.

description
string

Description of the product.

pallets_per_container_ft20
integer or null

Estimated number of pallets that fit into a 20ft container.

package_code
string or null

Package code of the product.

content_type
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Measurement unit type for the package contents (e.g. kg, liter, unit).

has_palletization
boolean or null

If Product has Palletization

content_capacity
string <decimal>

The capacity value (e.g. 1.5 for 1.5L or 1.5kg) of the content per package.

content_measurement_unit
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Unit used to quantify the product content.

packages_per_container_ft20
integer or null

Estimated number of packages that fit into a 20ft container.

additional_details
string or null

Additional details of the product.

multiple_code
string or null

Code identifying the multi-package configuration.

cubage_per_package
string or null <decimal>

Cubage (volume) per package, in cubic meters.

has_content
boolean or null

If Product has Content

gross_weight_per_package
string or null <decimal>

Gross weight per individual package, including packaging material.

packages_per_pallet
integer or null

Total number of packages that fit on a standard pallet.

mercosul_code
string or null

Mercosul Code (NCM) of the product.

packages_per_container_ft40
integer or null

Estimated number of packages that fit into a 40ft container.

Array of objects

An array of internal codes of this product.

net_weight_per_package
string or null <decimal>

Net weight per individual package, excluding packaging material.

product_foreign_operators
Array of integers

An array of Actor IDs to be associated as foreign operators for the product

multiple_package_per_container_ft40
integer or null

Estimated number of packages fitting by volume (cubage) in a 40ft container.

multiple_package_capacity
string or null <decimal>

Multiple package capacity of the product.

content_code
string or null

Internal or external code identifying the product content type.

Responses

Request samples

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

Response samples

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

Upsert Products in batch

Authorizations:
api-key
header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

The attributes to Upsert Products in batch

Array of objects (CreateProductParams)
Array
multiple_package_per_container_ft20
integer or null

Estimated number of packages fitting by volume (cubage) in a 20ft container.

category
string or null

Category of the product.

package_measurement_unit
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Package Measurement Unit of the product.

extra
json or null

Extra information related to the product.

package_capacity
string or null <decimal>

Package capacity of the product.

multiple_package_type
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Type of the multi-package unit (e.g. box, pallet, bag).

family
string or null

Family of the product.

pallets_per_container_ft40
integer or null

Estimated number of pallets that fit into a 40ft container.

has_unitization
boolean or null

If Product has Unitization

code
string

Code (SKU) of the product.

translated_descriptions
json or null

Translated descriptions related to the product.

manufacturer
string or null

Manufacturer of the product.

multiple_package_measurement_unit
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Multiple Package Measurement Unit of the product.

has_containerization
boolean or null

If Product has Containerization

package_type
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Package Type of the product.

description
string

Description of the product.

pallets_per_container_ft20
integer or null

Estimated number of pallets that fit into a 20ft container.

package_code
string or null

Package code of the product.

content_type
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Measurement unit type for the package contents (e.g. kg, liter, unit).

has_palletization
boolean or null

If Product has Palletization

content_capacity
string <decimal>

The capacity value (e.g. 1.5 for 1.5L or 1.5kg) of the content per package.

content_measurement_unit
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Unit used to quantify the product content.

packages_per_container_ft20
integer or null

Estimated number of packages that fit into a 20ft container.

additional_details
string or null

Additional details of the product.

multiple_code
string or null

Code identifying the multi-package configuration.

cubage_per_package
string or null <decimal>

Cubage (volume) per package, in cubic meters.

has_content
boolean or null

If Product has Content

gross_weight_per_package
string or null <decimal>

Gross weight per individual package, including packaging material.

packages_per_pallet
integer or null

Total number of packages that fit on a standard pallet.

mercosul_code
string or null

Mercosul Code (NCM) of the product.

packages_per_container_ft40
integer or null

Estimated number of packages that fit into a 40ft container.

Array of objects

An array of internal codes of this product.

net_weight_per_package
string or null <decimal>

Net weight per individual package, excluding packaging material.

product_foreign_operators
Array of integers

An array of Actor IDs to be associated as foreign operators for the product

multiple_package_per_container_ft40
integer or null

Estimated number of packages fitting by volume (cubage) in a 40ft container.

multiple_package_capacity
string or null <decimal>

Multiple package capacity of the product.

content_code
string or null

Internal or external code identifying the product content type.

Responses

Request samples

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

Response samples

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

Delete a Product

Authorizations:
api-key
path Parameters
id
required
integer
Example: 100

Product ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Get a Product

Authorizations:
api-key
path Parameters
id
required
integer
Example: 100

Product ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Update a Product

Authorizations:
api-key
path Parameters
id
required
integer
Example: 100

Product ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

The attributes to Update a Product

multiple_package_per_container_ft20
integer or null

Estimated number of packages fitting by volume (cubage) in a 20ft container.

category
string or null

Category of the product.

package_measurement_unit
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Package Measurement Unit of the product.

extra
json or null

Extra information related to the product.

package_capacity
string or null <decimal>

Package capacity of the product.

multiple_package_type
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Type of the multi-package unit (e.g. box, pallet, bag).

family
string or null

Family of the product.

pallets_per_container_ft40
integer

Estimated number of pallets that fit into a 40ft container.

has_unitization
boolean or null

If Product has Unitization

code
string

Code (SKU) of the product.

translated_descriptions
json or null

Translated descriptions related to the product.

manufacturer
string or null

Manufacturer of the product.

multiple_package_measurement_unit
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Multiple Package Measurement Unit of the product.

has_containerization
boolean or null

If Product has Containerization

package_type
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Package Type of the product.

description
string

Description of the product.

pallets_per_container_ft20
integer or null

Estimated number of pallets that fit into a 20ft container.

package_code
string or null

Package code of the product.

content_type
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Measurement unit type for the package contents (e.g. kg, liter, unit).

has_palletization
boolean or null

If Product has Palletization

content_capacity
string or null <decimal>

The capacity value (e.g. 1.5 for 1.5L or 1.5kg) of the content per package.

content_measurement_unit
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Unit used to quantify the product content.

packages_per_container_ft20
integer or null

Estimated number of packages that fit into a 20ft container.

additional_details
string or null

Additional details of the product.

multiple_code
string or null

Code identifying the multi-package configuration.

cubage_per_package
string or null <decimal>

Cubage (volume) per package, in cubic meters.

has_content
boolean or null

If Product has Content

gross_weight_per_package
string or null <decimal>

Gross weight per individual package, including packaging material.

packages_per_pallet
integer or null

Total number of packages that fit on a standard pallet.

mercosul_code
string or null

Mercosul Code (NCM) of the product.

packages_per_container_ft40
integer or null

Estimated number of packages that fit into a 40ft container.

Array of objects

An array of internal codes of this product.

net_weight_per_package
string or null <decimal>

Net weight per individual package, excluding packaging material.

product_foreign_operators
Array of integers

An array of Actor IDs to be associated as foreign operators for the product

multiple_package_per_container_ft40
integer or null

Estimated number of packages fitting by volume (cubage) in a 40ft container.

multiple_package_capacity
string or null <decimal>

Multiple package capacity of the product.

content_code
string or null

Internal or external code identifying the product content type.

Responses

Request samples

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

Response samples

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

Delete a Product by Code

Authorizations:
api-key
path Parameters
code
required
string
Example: PRD-01

Product Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Get a Product by Code

Authorizations:
api-key
path Parameters
code
required
string
Example: PRD-01

Product Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Update a Product by Code

Authorizations:
api-key
path Parameters
code
required
string
Example: PRD-01

Product Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

The attributes to Update a Product

multiple_package_per_container_ft20
integer or null

Estimated number of packages fitting by volume (cubage) in a 20ft container.

category
string or null

Category of the product.

package_measurement_unit
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Package Measurement Unit of the product.

extra
json or null

Extra information related to the product.

package_capacity
string or null <decimal>

Package capacity of the product.

multiple_package_type
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Type of the multi-package unit (e.g. box, pallet, bag).

family
string or null

Family of the product.

pallets_per_container_ft40
integer

Estimated number of pallets that fit into a 40ft container.

has_unitization
boolean or null

If Product has Unitization

code
string

Code (SKU) of the product.

translated_descriptions
json or null

Translated descriptions related to the product.

manufacturer
string or null

Manufacturer of the product.

multiple_package_measurement_unit
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Multiple Package Measurement Unit of the product.

has_containerization
boolean or null

If Product has Containerization

package_type
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Package Type of the product.

description
string

Description of the product.

pallets_per_container_ft20
integer or null

Estimated number of pallets that fit into a 20ft container.

package_code
string or null

Package code of the product.

content_type
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Measurement unit type for the package contents (e.g. kg, liter, unit).

has_palletization
boolean or null

If Product has Palletization

content_capacity
string or null <decimal>

The capacity value (e.g. 1.5 for 1.5L or 1.5kg) of the content per package.

content_measurement_unit
string or null
Enum: "BOTTLES" "GRAMS" "KILOGRAMS" "TONS" "CENTIMETERS" "SQUARE_CENTIMETERS" "METERS" "SQUARE_METERS" "CUBIC_METERS" "BUCKETS" "AMPOULES" "TRAYS" "BARS" "TUBES" "BLOCKS" "COILS" "CAPSULES" "CARDS" "HUNDREDS" "GROUPS" "CONTAINERS" "BOXES" "DISPLAYS" "DOZENS" "PACKAGING" "BALES" "PAPERS" "FLASKS" "GALLONS" "ISOTANK" "SETS" "KITS" "CANS" "LITERS" "MILLILITERS" "THOUSAND" "MEGAWATT_HOUR" "PACKAGES" "PALLETS" "PAIRS" "PIECES" "POTS" "CARATS" "REAM" "ROLLS" "SACKS" "BAGS" "DRUMS" "TANKS" "PIPES" "UNITS" "BARRELS" "GLASSES" "POUNDS" "OUNCES"

Unit used to quantify the product content.

packages_per_container_ft20
integer or null

Estimated number of packages that fit into a 20ft container.

additional_details
string or null

Additional details of the product.

multiple_code
string or null

Code identifying the multi-package configuration.

cubage_per_package
string or null <decimal>

Cubage (volume) per package, in cubic meters.

has_content
boolean or null

If Product has Content

gross_weight_per_package
string or null <decimal>

Gross weight per individual package, including packaging material.

packages_per_pallet
integer or null

Total number of packages that fit on a standard pallet.

mercosul_code
string or null

Mercosul Code (NCM) of the product.

packages_per_container_ft40
integer or null

Estimated number of packages that fit into a 40ft container.

Array of objects

An array of internal codes of this product.

net_weight_per_package
string or null <decimal>

Net weight per individual package, excluding packaging material.

product_foreign_operators
Array of integers

An array of Actor IDs to be associated as foreign operators for the product

multiple_package_per_container_ft40
integer or null

Estimated number of packages fitting by volume (cubage) in a 40ft container.

multiple_package_capacity
string or null <decimal>

Multiple package capacity of the product.

content_code
string or null

Internal or external code identifying the product content type.

Responses

Request samples

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

Response samples

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

SalesOrderItem

Update a Sales Order Item

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: 123

Reference Code

line_reference
required
string
Example: 1

Line Reference

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

The attributes to Update a Sales Order Item

object
cubage_cubic_meters
string or null <number>

Cubage in cubic meters.

dispatch_number
string or null

The Dispatch number.

factory_delivery_at
string or null <date-time>

Factory Delivery At.

factory_estimated_delivery_at
string or null <date-time>

Forecast Factory Delivery At.

gross_weight_kg
string or null <number>

Gross weight in kilograms.

id
integer

Unique identifier for the SOI.

item_status
string or null

Item Status

line_number
integer or null

The line number associated with this SOI.

line_reference
string

The line reference associated with this item.

measurement_unit_sap
string or null

Measurement unit from SAP.

necessity_type
string or null

Necessity type

net_weight_kg
string or null <number>

Net weight in kilograms.

order_currency_code
string or null

Order Currency Code.

order_item_reference
string or null

Order Item Reference.

order_request_number
string or null

Order Request Number.

order_unit_value
string or null <number>

Order Unit Value.

order_value
string or null <number>

Order Value.

product_code
string

Code (SKU) of the product. As an alternative, you can also use product_id

product_id
integer

Unique identifier for the Product. As an alternative, you can also use product_code

quantity
string or null <number>

The quantity of products associated with this SOI.

shipment_containers_quantity
string or null <number>

Shipment Containers Quantity.

shipment_equipment_type
string or null

Shipment Equipment Type.

shipment_planned_arrival_at
string or null <date-time>

Shipment Planned Arrival At.

shipment_planned_boarding_at
string or null <date-time>

Shipment Planned Boarding At.

supplier_estimated_ready_at
string or null <date-time>

Supplier Estimated Readiness At.

supplier_planned_ready_at
string or null <date-time>

Supplier Planned Readiness At.

supplier_ready_at
string or null <date-time>

Supplier Readiness At.

ubc
string or null

UBC Code

Responses

Request samples

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

Response samples

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

Vessel

List Vessels

Authorizations:
api-key
query Parameters
object

Parameter for controlling pagination of the result set.

search
string

Search

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Get Vessel Current Voyage by MMSI

Authorizations:
api-key
path Parameters
mmsi
required
string
Example: 538006242

MMSI number of the vessel

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Cost

Reopen a Cost

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

process_id
required
integer
Example: 100

Process ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Close a Cost

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

process_id
required
integer
Example: 100

Process ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Upsert Cost Per Expenses in batch

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

process_id
required
integer
Example: 1

Process ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

The attributes to Upsert Cost Per Expenses

Array of objects
Array
cost
required
string or null <decimal>

Cost value.

cost_model_expense_id
required
integer

Cost Model Expense identifier.

planned_cost
string or null <decimal>

Planned Cost value.

Responses

Request samples

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

Response samples

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

Get Cost Model by ID

Authorizations:
api-key
path Parameters
id
required
integer
Example: 1

Model ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Get Cost Model Version by ID

Authorizations:
api-key
path Parameters
id
required
integer
Example: 1

Model Version ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

List Cost Models of an Operation

Authorizations:
api-key
query Parameters
object

Parameter for controlling pagination of the result set.

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Documents

Upload Document by Reference Code

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: PRC-01

Reference Code

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: multipart/form-data
optional

The attributes to Create a Document

description
string or null

The description of the Document.

external_id
string or null

The external id of the Document.

file
required
string <binary>

The file associated with this Document.

invoice_id
integer or null

ID of the associated Invoice.

parent_document_id
integer or null

ID of the parent Document.

type
required
string
Enum: "ANALYSIS_CERTIFICATE" "BILL_OF_LADING" "BOOKING" "BRAZILIAN_INVOICE" "COLLECT_ORDER" "COMMERCIAL_INVOICE" "CONTAINER_ARRIVAL_NOTICE" "CONTAINER_DAMAGE" "CONTAINER_PROOF_OF_RETURN" "CORRECTION_LETTER" "CUSTOMS_TRANSIT_DECLARATION" "DANGEROUS_GOODS_REQUEST" "DI_RECTIFICATION_STATEMENT" "DRAUGHT_REPORT" "EXPORT_DECLARATION" "EXPORT_DECLARATION_DUE" "FREIGHT_QUOTE" "FREIGHT_RECEIPTS" "FUMIGATION_CERTIFICATE" "GRU_ANVISA" "HEALTH_CERTIFICATE" "ICMS" "IMPORT_DECLARATION" "IMPORT_DECLARATION_DI" "IMPORT_DECLARATION_DUIMP" "IMPORT_LICENSE" "IMPORT_LICENSE_LI" "INSPECTION_CERTIFICATE" "INSURANCE_POLICY" "INVOICE" "LPCO" "MAPA_APPROVAL" "MDFE" "MERCHANT_MARINE_DOCUMENT" "ORDER_CONFIRMATION" "ORIGIN_CERTIFICATE" "OTHER" "PACKING_LIST" "PHYTOSANITARY_CERTIFICATE" "PROFORMA_INVOICE" "PROOF_OF_DELIVERY" "PURCHASE_ORDER" "QUALITY_CERTIFICATE" "SALES_ORDER" "SHIPPING_ADVICE" "SHIPPING_INSTRUCTIONS" "TRANSPORT_ACKNOWLEDGMENT" "VETERINARY_CERTIFICATE" "WEIGHT_AND_QUALITY_CERTIFICATE" "WEIGHT_CERTIFICATE" "HAWB" "CRT" "SHIPMENT_DOCUMENT" "FOREIGN_EXCHANGE_CONTRACT" "PROOF_OF_PAYMENT" "SHIPPING_DOCUMENTS_FOR_APPROVAL" "APPROVED_SHIPPING_DOCUMENTS" "SHIPMENT_PRE_ALERT" "DEBIT_NOTE" "SALES_CONTRACT" "DATE_CERTIFICATE" "CARBENDAZIM_TEST_REPORT" "WOOD_PACKAGING_DECLARATION" "ADDITIONAL_INSURANCE_DOCUMENTS" "MIC" "DRAFT_CO" "DRAFT_BL" "ISF_5" "ISF_10" "LAB_ANALYSIS_REPORT" "SANITARY_CERTIFICATE" "COST_CLOSING" "STUFFING_PLAN"

The type of Document.

Responses

Response samples

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

Upload Document

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

process_id
required
integer
Example: 100

Process ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: multipart/form-data
optional

The attributes to Create a Document

description
string or null

The description of the Document.

external_id
string or null

The external id of the Document.

file
required
string <binary>

The file associated with this Document.

invoice_id
integer or null

ID of the associated Invoice.

parent_document_id
integer or null

ID of the parent Document.

type
required
string
Enum: "ANALYSIS_CERTIFICATE" "BILL_OF_LADING" "BOOKING" "BRAZILIAN_INVOICE" "COLLECT_ORDER" "COMMERCIAL_INVOICE" "CONTAINER_ARRIVAL_NOTICE" "CONTAINER_DAMAGE" "CONTAINER_PROOF_OF_RETURN" "CORRECTION_LETTER" "CUSTOMS_TRANSIT_DECLARATION" "DANGEROUS_GOODS_REQUEST" "DI_RECTIFICATION_STATEMENT" "DRAUGHT_REPORT" "EXPORT_DECLARATION" "EXPORT_DECLARATION_DUE" "FREIGHT_QUOTE" "FREIGHT_RECEIPTS" "FUMIGATION_CERTIFICATE" "GRU_ANVISA" "HEALTH_CERTIFICATE" "ICMS" "IMPORT_DECLARATION" "IMPORT_DECLARATION_DI" "IMPORT_DECLARATION_DUIMP" "IMPORT_LICENSE" "IMPORT_LICENSE_LI" "INSPECTION_CERTIFICATE" "INSURANCE_POLICY" "INVOICE" "LPCO" "MAPA_APPROVAL" "MDFE" "MERCHANT_MARINE_DOCUMENT" "ORDER_CONFIRMATION" "ORIGIN_CERTIFICATE" "OTHER" "PACKING_LIST" "PHYTOSANITARY_CERTIFICATE" "PROFORMA_INVOICE" "PROOF_OF_DELIVERY" "PURCHASE_ORDER" "QUALITY_CERTIFICATE" "SALES_ORDER" "SHIPPING_ADVICE" "SHIPPING_INSTRUCTIONS" "TRANSPORT_ACKNOWLEDGMENT" "VETERINARY_CERTIFICATE" "WEIGHT_AND_QUALITY_CERTIFICATE" "WEIGHT_CERTIFICATE" "HAWB" "CRT" "SHIPMENT_DOCUMENT" "FOREIGN_EXCHANGE_CONTRACT" "PROOF_OF_PAYMENT" "SHIPPING_DOCUMENTS_FOR_APPROVAL" "APPROVED_SHIPPING_DOCUMENTS" "SHIPMENT_PRE_ALERT" "DEBIT_NOTE" "SALES_CONTRACT" "DATE_CERTIFICATE" "CARBENDAZIM_TEST_REPORT" "WOOD_PACKAGING_DECLARATION" "ADDITIONAL_INSURANCE_DOCUMENTS" "MIC" "DRAFT_CO" "DRAFT_BL" "ISF_5" "ISF_10" "LAB_ANALYSIS_REPORT" "SANITARY_CERTIFICATE" "COST_CLOSING" "STUFFING_PLAN"

The type of Document.

Responses

Response samples

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

Delete Document by Reference Code

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: PRC-01

Reference Code

id
required
integer
Example: 100

Document ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Delete Document

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

process_id
required
integer
Example: 100

Process ID

id
required
integer
Example: 100

Document ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Actor

Get an Actor

Authorizations:
api-key
path Parameters
id
required
integer
Example: 100

Actor ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Upsert a Partnership

Creates a new Partnership or updates an existing one.

Authorizations:
api-key
header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

Parameters to create or update a Partnership

required
object (CreateBasePartnershipParams)

Parameters to create or update a Partnership and its associated Actor.

contact_details
string or null

Contact details of the Partnership.

description
string or null

Description of the Partnership.

document_type
string
Enum: "CNPJ" "CPF" "TIN" "INTERNAL_CODE"

The type of official document. Must be provided along with official_document.

internal_code
string

Internal code of the Partnership. As an alternative you can use official_document + document_type to create a partnership.

name
required
string

Name/nickname of the Actor.

official_document
string

The official document that identifies the actor.

required
Array of objects

List of roles that the Actor will have in the Partnership.

Responses

Request samples

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

Response samples

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

List Actors

Authorizations:
api-key
query Parameters
object

Parameter for controlling pagination of the result set.

object

Filters

search
string

Search

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Route

List Routes

Authorizations:
api-key
query Parameters
object

Parameter for controlling pagination of the result set.

object

Filters

search
string

Search

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Get a Route

Authorizations:
api-key
path Parameters
id
required
integer
Example: 100

Route ID

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

Partnership

Upsert a Partnership

Creates a new Partnership or updates an existing one.

Authorizations:
api-key
header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

Parameters to create or update a Partnership

required
object (CreateBasePartnershipParams)

Parameters to create or update a Partnership and its associated Actor.

contact_details
string or null

Contact details of the Partnership.

description
string or null

Description of the Partnership.

document_type
string
Enum: "CNPJ" "CPF" "TIN" "INTERNAL_CODE"

The type of official document. Must be provided along with official_document.

internal_code
string

Internal code of the Partnership. As an alternative you can use official_document + document_type to create a partnership.

name
required
string

Name/nickname of the Actor.

official_document
string

The official document that identifies the actor.

required
Array of objects

List of roles that the Actor will have in the Partnership.

Responses

Request samples

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

Response samples

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

PortSchedule

List Port Schedules

Authorizations:
api-key
path Parameters
port_unlocode
required
string
Example: BRSSZ

Port UN/LOCODE

query Parameters
object

Parameter for controlling pagination of the result set.

start_date_etb
required
string
Example: start_date_etb=2024-01-01

Minimum ETB to be considered in the format ISO 8601

end_date_etb
required
string
Example: end_date_etb=2024-02-01

Maximum ETB to be considered in the format ISO 8601

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Responses

Response samples

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

PurchaseOrderItem

Update a Purchase Order Item

Authorizations:
api-key
path Parameters
operation_id
required
integer
Example: 1

Operation ID

reference_code
required
string
Example: 123

Reference Code

line_reference
required
string
Example: 1

Line Reference

header Parameters
locale
string
Default: pt-BR
Enum: "pt-BR" "en-US" "es-ES"
Example: pt-BR

The 'locale' parameter allows specify the desired language for translating messages returned by the Server.

Request Body schema: application/json
optional

The attributes to Update a Purchase Order Item

object
net_weight_kg
string or null <number>

Net weight in kilograms.

order_value
string or null <number>

Order Value.

shipment_estimated_boarding_at
string or null <date-time>

Shipment Estimated Boarding At.

supplier_confirmation_at
string or null <date-time>

Supplier Confirmation At.

manufacturing_country_code
string or null

Manufacturing Country Code.

line_number
integer or null

The line number associated with this POI.

line_reference
string

The line reference associated with this POI.

customs_release_lead_time
integer or null

Customs release Lead Time in Days.

order_unit_value
string or null <number>

Order Unit Value.

shipment_estimated_arrival_at
string or null <date-time>

Shipment Estimated Arrival At.

import_type_sap
string or null

Import type from SAP.

division
string or null

Item Division

shipment_planned_boarding_at
string or null <date-time>

Shipment Planned Boarding At.

sap_by_factor
string or null <number>

POR factor from SAP.

order_modal_type_sap
string or null

Order Modal Type from SAP.

shipment_equipment_type
string or null

Shipment Equipment Type.

order_item_reference
string or null

Order Item Reference.

factory_estimated_delivery_at
string or null <date-time>

Factory Estimated Delivery At.

delivery_note
string or null

Delivery Note.

factory_delivery_lead_time
integer or null

Factory delivery Lead Time in Days.

adjusted_factory_delivery_lead_time
integer or null

Adjusted factory delivery lead time in days.

product_code
string

Code (SKU) of the product. As an alternative, you can also use product_id

assessment_sotd
string or null

SOTD (Supplier On-time Delivery)

planning_request_shipping_at
string or null <date-time>

Request Shipping At.

order_adjusted_modal_type
string or null

Order Adjusted Modal Type.

order_request_number
string or null

Order Request Number.

concession_act
string or null

Concession Act.

customs_estimated_release_at
string or null <date-time>

Customs estimated date of release.

purchase_country_code
string or null

Purchase Country Code.

adjusted_customs_release_lead_time
integer or null

Adjusted customs release lead time in days.

measurement_unit_sap
string or null

Measurement unit from SAP.

shipment_transport_lead_time
integer or null

Shipment transport Lead Time in Days.

id
integer

Unique identifier for the POI.

order_requested_at
string or null <date-time>

Order requested at (PO Operador)

delivery_note_issued_at
string or null <date>

Delivery Note Issued At.

gross_weight_kg
string or null <number>

Gross weight in kilograms.

supplier_ready_lead_time_days
integer or null

Supplier Readiness Lead Time Days.

quantity
string or null <number>

The quantity of products associated with this POI.

invoice_issued_at
string or null <date>

Invoice Issued At.

shipment_planned_arrival_at
string or null <date-time>

Shipment Planned Arrival At.

supplier_estimated_ready_at
string or null <date-time>

Supplier Estimated Readiness At.

order_currency_code
string or null

Order Currency Code.

invoice_value
string or null <number>

Invoice Value.

customs_register_lead_time
integer or null

Customs DI registration Lead Time in Days.

adjusted_shipment_transport_lead_time
integer or null

Adjusted shipment transport lead time in days.

planning_shipping_at
string or null <date-time>

Shipping At.

invoice_number
string or null

Invoice Number.

adjusted_customs_register_lead_time
integer or null

Adjusted customs register lead time in days.

customs_estimated_register_at
string or null <date-time>

Customs estimated date of DI registration.

shipment_containers_quantity
string or null <number>

Shipment Containers Quantity.

product_id
integer

Unique identifier for the Product. As an alternative, you can also use product_code

supplier_sent_at
string or null <date-time>

Supplier Sent At.

supplier_ready_at
string or null <date-time>

Supplier Readiness At.

dispatching_country_code
string or null

Dispatching Country Code.

factory_delivery_at
string or null <date-time>

Factory Delivery At.

factory_planned_delivery_at
string or null <date-time>

Factory Planned Delivery At.

item_foreign_operators
Array of integers or null

Unique identifiers for the Foreign Operator.

adjusted_shipment_boarding_lead_time
integer or null

Adjusted shipment boarding lead time in days.

item_status
string or null

Item Status

adjusted_supplier_ready_lead_time_days
integer or null

Adjusted supplier ready lead time in days.

supplier_planned_ready_at
string or null <date-time>

Supplier Planned Readiness At.

supplier_calculated_ready_at
string or null <date-time>

Supplier Calculated Readiness At.

cubage_cubic_meters
string or null <number>

Cubage in cubic meters.

Responses

Request samples

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

Response samples

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