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