Skip to main content
API docs by Redocly

Flows API Documentation (1.0)

Download OpenAPI specification:Download

Order

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

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: en-US
Enum: "pt-BR" "en-US"
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: en-US
Enum: "pt-BR" "en-US"
Example: pt-BR

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

Request Body schema: application/json

The attributes to Create an Order

object
external_reference_code
string or null

An external reference code associated with the Order.

Array of objects (NestedCreateHandlerParams)

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": {
    }
}

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: en-US
Enum: "pt-BR" "en-US"
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: en-US
Enum: "pt-BR" "en-US"
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: en-US
Enum: "pt-BR" "en-US"
Example: pt-BR

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

Request Body schema: application/json

The attributes to Update an Order

object
external_reference_code
string or null

An external reference code associated with the Order.

Array of objects (NestedUpdateHandlerParams)

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: en-US
Enum: "pt-BR" "en-US"
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

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: en-US
Enum: "pt-BR" "en-US"
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: en-US
Enum: "pt-BR" "en-US"
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": {
    }
}

Process

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

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: en-US
Enum: "pt-BR" "en-US"
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: en-US
Enum: "pt-BR" "en-US"
Example: pt-BR

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

Request Body schema: application/json

The attributes to Create a Process

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

Alert level indicating the severity of the Process.

object or null

A Foreign Trade Shipment associated with this Process.

Array of objects (NestedCreateHandlerParams)

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 Orders associated with this Process.

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 list of Processes using reference_code as the key. Create new entries if they don't exist, and update existing entries if they do.

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

Operation ID

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

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

Request Body schema: application/json

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.

object or null

A Foreign Trade Shipment associated with this Process.

Array of objects (NestedUpdateHandlerParams)

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 Orders associated with this Process.

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": [
    ]
}

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: en-US
Enum: "pt-BR" "en-US"
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: en-US
Enum: "pt-BR" "en-US"
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: en-US
Enum: "pt-BR" "en-US"
Example: pt-BR

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

Request Body schema: application/json

The attributes to Update a Process

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

Alert level indicating the severity of the Process.

object or null

A Foreign Trade Shipment associated with this Process.

Array of objects (NestedUpdateHandlerParams)

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 Orders associated with this Process.

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: en-US
Enum: "pt-BR" "en-US"
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

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: en-US
Enum: "pt-BR" "en-US"
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: en-US
Enum: "pt-BR" "en-US"
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: en-US
Enum: "pt-BR" "en-US"
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: en-US
Enum: "pt-BR" "en-US"
Example: pt-BR

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

Request Body schema: application/json

The attributes to Create a Product

c9_ratio
string or null <decimal>

C9 ratio of the product.

category
string or null

Category of the product.

code
string

Code (SKU) of the product.

description
string

Description of the product.

extra
json or null

Extra information related to the product.

family
string or null

Family of the product.

Array of objects

An array of internal codes of this product.

manufacturer
string or null

Manufacturer of the product.

mercosul_code
string or null

Mercosul Code (NCM) of the product.

multiple_package_capacity
string or null <decimal>

Multiple package capacity 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"

Multiple Package Measurement Unit of the product.

package_capacity
string or null <decimal>

Package capacity of the product.

package_code
string or null

Package code 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"

Package Measurement Unit of the product.

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"

Package Type of the product.

product_foreign_operators
Array of integers

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

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: en-US
Enum: "pt-BR" "en-US"
Example: pt-BR

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

Request Body schema: application/json

The attributes to Upsert Products in batch

Array of objects (CreateProductParams)
Array
c9_ratio
string or null <decimal>

C9 ratio of the product.

category
string or null

Category of the product.

code
string

Code (SKU) of the product.

description
string

Description of the product.

extra
json or null

Extra information related to the product.

family
string or null

Family of the product.

Array of objects

An array of internal codes of this product.

manufacturer
string or null

Manufacturer of the product.

mercosul_code
string or null

Mercosul Code (NCM) of the product.

multiple_package_capacity
string or null <decimal>

Multiple package capacity 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"

Multiple Package Measurement Unit of the product.

package_capacity
string or null <decimal>

Package capacity of the product.

package_code
string or null

Package code 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"

Package Measurement Unit of the product.

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"

Package Type of the product.

product_foreign_operators
Array of integers

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

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: en-US
Enum: "pt-BR" "en-US"
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: en-US
Enum: "pt-BR" "en-US"
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: en-US
Enum: "pt-BR" "en-US"
Example: pt-BR

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

Request Body schema: application/json

The attributes to Update a Product

c9_ratio
string or null <decimal>

C9 ratio of the product.

category
string or null

Category of the product.

code
string

Code (SKU) of the product.

description
string

Description of the product.

extra
json or null

Extra information related to the product.

family
string or null

Family of the product.

Array of objects

An array of internal codes of this product.

manufacturer
string or null

Manufacturer of the product.

mercosul_code
string or null

Mercosul Code (NCM) of the product.

multiple_package_capacity
string or null <decimal>

Multiple package capacity 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"

Multiple Package Measurement Unit of the product.

package_capacity
string or null <decimal>

Package capacity of the product.

package_code
string or null

Package code 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"

Package Measurement Unit of the product.

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"

Package Type of the product.

product_foreign_operators
Array of integers

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

Responses

Request samples

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

Response samples

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

Actor

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: en-US
Enum: "pt-BR" "en-US"
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 Actor

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

Actor ID

header Parameters
locale
string
Default: en-US
Enum: "pt-BR" "en-US"
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": {
    }
}

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: en-US
Enum: "pt-BR" "en-US"
Example: pt-BR

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

Request Body schema: application/json

The attributes to Update a Purchase Order Item

object
net_weight_kg
string or null <number>

Net weight in kilograms.

assessment_sotd
string or null

SOTD (Supplier On-time Delivery)

id
integer

Unique identifier for the POI.

factory_delivery_lead_time
integer or null

Factory delivery Lead Time in Days.

shipment_estimated_arrival_at
string or null <date-time>

Shipment Estimated Arrival At.

shipment_equipment_type
string or null

Shipment Equipment Type.

quantity
string or null <number>

The quantity of products associated with this POI.

order_request_number
string or null

Order Request Number.

order_adjusted_modal_type
string or null

Order Adjusted Modal Type.

measurement_unit_sap
string or null

Measurement unit from SAP.

customs_estimated_register_at
string or null <date-time>

Customs estimated date of DI registration.

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.

shipment_containers_quantity
string or null <number>

Shipment Containers Quantity.

planning_request_shipping_at
string or null <date-time>

Request Shipping At.

factory_delivery_at
string or null <date-time>

Factory Delivery At.

item_foreign_operators
Array of integers or null

Unique identifiers for the Foreign Operator.

supplier_confirmation_at
string or null <date-time>

Supplier Confirmation At.

sap_by_factor
string or null <number>

POR factor from SAP.

supplier_sent_at
string or null <date-time>

Supplier Sent At.

customs_estimated_release_at
string or null <date-time>

Customs estimated date of release.

order_currency_code
string or null

Order Currency Code.

planning_shipping_at
string or null <date-time>

Shipping At.

supplier_planned_ready_at
string or null <date-time>

Supplier Planned Readiness At.

shipment_estimated_boarding_at
string or null <date-time>

Shipment Estimated Boarding At.

order_item_reference
string or null

Order Item Reference.

product_id
integer

Unique identifier for the Product.

customs_release_lead_time
integer or null

Customs release Lead Time in Days.

order_value
string or null <number>

Order Value.

factory_planned_delivery_at
string or null <date-time>

Factory Planned Delivery At.

supplier_ready_lead_time_days
integer or null

Supplier Readiness Lead Time Days.

customs_register_lead_time
integer or null

Customs DI registration Lead Time in Days.

order_modal_type_sap
string or null

Order Modal Type from SAP.

line_reference
string

The line reference associated with this POI.

supplier_ready_at
string or null <date-time>

Supplier Readiness At.

order_requested_at
string or null <date-time>

Order requested at (PO Operador)

factory_estimated_delivery_at
string or null <date-time>

Factory Estimated Delivery At.

supplier_calculated_ready_at
string or null <date-time>

Supplier Calculated Readiness At.

shipment_planned_boarding_at
string or null <date-time>

Shipment Planned Boarding At.

item_status
string or null

Item Status

shipment_transport_lead_time
integer or null

Shipment transport Lead Time in Days.

line_number
integer or null

The line number associated with this POI.

Responses

Request samples

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

Response samples

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

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: en-US
Enum: "pt-BR" "en-US"
Example: pt-BR

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

Request Body schema: application/json

The attributes to Update a Sales Order Item

object
factory_delivery_at
string or null <date-time>

Factory Delivery At.

factory_estimated_delivery_at
string or null <date-time>

Forecast Factory Delivery At.

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.

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_value
string or null <number>

Order Value.

product_id
integer

Unique identifier for the Product.

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.

Responses

Request samples

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

Response samples

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

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: en-US
Enum: "pt-BR" "en-US"
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
}

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: en-US
Enum: "pt-BR" "en-US"
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: en-US
Enum: "pt-BR" "en-US"
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": {
    }
}

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: en-US
Enum: "pt-BR" "en-US"
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": [
    ]
}