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": [{"canceled_at": null,
"deleted_at": null,
"external_reference_code": "ECT1",
"finished_at": null,
"handlers": [{"actor": {"cnae": "",
"document_type": "CNPJ",
"id": 1,
"logo_url": null,
"nickname": "Nickname",
"official_document": "11111111111111",
"official_name": "Actor",
"opening_date": "2023-01-01",
"roles": ["CARGO_OWNER"
],
"trading_name": "Trading Name",
"verified": true
},
"business_unit": "Business Unit",
"id": 1,
"reference": "Handler Reference",
"secondary_reference": "Handler Secondary Reference"
}
],
"id": 123,
"inserted_at": "2023-10-29T00:00:00Z",
"observations": "Observations...",
"processes": [{"id": 1,
"reference_code": "23PRC0000001"
},
{"id": 2,
"reference_code": "23PRC0000002"
}
],
"purchase_order": {"id": 123,
"items": [{"balance": "10.0",
"balance_shipped": "10.0",
"id": 123,
"line_number": 1,
"product": {"id": 2
},
"quantity": "20.0"
}
],
"necessity_date": "2023-10-29T00:00:00Z",
"supplier_expected_readiness_at": "2023-10-29T00:00:00Z",
"supplier_order_accepted_at": "2023-10-29T00:00:00Z",
"supplier_order_sent_at": "2023-10-29T00:00:00Z",
"supplier_readiness_at": "2023-10-29T00:00:00Z",
"type": "INDIRECT"
},
"reference_code": "23ORC0000001",
"subsidiary": {"id": 1,
"name": "Subsidiary"
},
"type": "PURCHASE"
}
]
}

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.
subsidiary_id	integer or null Unique identifier for the Subsidiary.

Responses

Request samples

Payload

Content type

application/json

{"params": {"external_reference_code": "ECT1",
"handlers": [ ],
"observations": "Observations...",
"purchase_order": {"items": [{"item_foreign_operators": [ ],
"line_number": 1,
"product_id": 1,
"quantity": "20.0"
}
],
"necessity_date": "2023-10-29T00:00:00Z",
"supplier_expected_readiness_at": "2023-10-29T00:00:00Z",
"supplier_order_accepted_at": "2023-10-29T00:00:00Z",
"supplier_order_sent_at": "2023-10-29T00:00:00Z",
"supplier_readiness_at": "2023-10-29T00:00:00Z",
"type": "INDIRECT"
},
"reference_code": "23PRC0000001"
}
}

Response samples

Content type

application/json

{"data": {"canceled_at": null,
"deleted_at": null,
"external_reference_code": "ECT1",
"finished_at": null,
"handlers": [{"actor": {"cnae": "",
"document_type": "CNPJ",
"id": 1,
"logo_url": null,
"nickname": "Nickname",
"official_document": "11111111111111",
"official_name": "Actor",
"opening_date": "2023-01-01",
"roles": ["CARGO_OWNER"
],
"trading_name": "Trading Name",
"verified": true
},
"business_unit": "Business Unit",
"id": 1,
"reference": "Handler Reference",
"secondary_reference": "Handler Secondary Reference"
}
],
"id": 123,
"inserted_at": "2023-10-29T00:00:00Z",
"observations": "Observations...",
"processes": [{"id": 1,
"reference_code": "23PRC0000001"
},
{"id": 2,
"reference_code": "23PRC0000002"
}
],
"purchase_order": {"id": 123,
"items": [{"balance": "10.0",
"balance_shipped": "10.0",
"id": 123,
"line_number": 1,
"product": {"id": 2
},
"quantity": "20.0"
}
],
"necessity_date": "2023-10-29T00:00:00Z",
"supplier_expected_readiness_at": "2023-10-29T00:00:00Z",
"supplier_order_accepted_at": "2023-10-29T00:00:00Z",
"supplier_order_sent_at": "2023-10-29T00:00:00Z",
"supplier_readiness_at": "2023-10-29T00:00:00Z",
"type": "INDIRECT"
},
"reference_code": "23ORC0000001",
"subsidiary": {"id": 1,
"name": "Subsidiary"
},
"type": "PURCHASE"
}
}

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": {"deleted_at": "2019-08-24T14:15:22Z",
"id": 0
}
}

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": {"canceled_at": null,
"deleted_at": null,
"external_reference_code": "ECT1",
"finished_at": null,
"handlers": [{"actor": {"cnae": "",
"document_type": "CNPJ",
"id": 1,
"logo_url": null,
"nickname": "Nickname",
"official_document": "11111111111111",
"official_name": "Actor",
"opening_date": "2023-01-01",
"roles": ["CARGO_OWNER"
],
"trading_name": "Trading Name",
"verified": true
},
"business_unit": "Business Unit",
"id": 1,
"reference": "Handler Reference",
"secondary_reference": "Handler Secondary Reference"
}
],
"id": 123,
"inserted_at": "2023-10-29T00:00:00Z",
"observations": "Observations...",
"processes": [{"id": 1,
"reference_code": "23PRC0000001"
},
{"id": 2,
"reference_code": "23PRC0000002"
}
],
"purchase_order": {"id": 123,
"items": [{"balance": "10.0",
"balance_shipped": "10.0",
"id": 123,
"line_number": 1,
"product": {"id": 2
},
"quantity": "20.0"
}
],
"necessity_date": "2023-10-29T00:00:00Z",
"supplier_expected_readiness_at": "2023-10-29T00:00:00Z",
"supplier_order_accepted_at": "2023-10-29T00:00:00Z",
"supplier_order_sent_at": "2023-10-29T00:00:00Z",
"supplier_readiness_at": "2023-10-29T00:00:00Z",
"type": "INDIRECT"
},
"reference_code": "23ORC0000001",
"subsidiary": {"id": 1,
"name": "Subsidiary"
},
"type": "PURCHASE"
}
}

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.
subsidiary_id	integer or null Unique identifier for the Subsidiary.

Responses

Request samples

Payload

Content type

application/json

{"params": {"external_reference_code": "",
"handlers": [ ],
"observations": "Observations...",
"purchase_order": {"items": [{"id": 1,
"item_foreign_operators": [ ],
"line_number": 1,
"product_id": 1,
"quantity": "20.0"
}
],
"necessity_date": "2023-10-29T00:00:00Z",
"supplier_expected_readiness_at": "2023-10-29T00:00:00Z",
"supplier_order_accepted_at": "2023-10-29T00:00:00Z",
"supplier_order_sent_at": "2023-10-29T00:00:00Z",
"supplier_readiness_at": "2023-10-29T00:00:00Z",
"type": "INDIRECT"
}
}
}

Response samples

Content type

application/json

{"data": {"canceled_at": null,
"deleted_at": null,
"external_reference_code": "ECT1",
"finished_at": null,
"handlers": [{"actor": {"cnae": "",
"document_type": "CNPJ",
"id": 1,
"logo_url": null,
"nickname": "Nickname",
"official_document": "11111111111111",
"official_name": "Actor",
"opening_date": "2023-01-01",
"roles": ["CARGO_OWNER"
],
"trading_name": "Trading Name",
"verified": true
},
"business_unit": "Business Unit",
"id": 1,
"reference": "Handler Reference",
"secondary_reference": "Handler Secondary Reference"
}
],
"id": 123,
"inserted_at": "2023-10-29T00:00:00Z",
"observations": "Observations...",
"processes": [{"id": 1,
"reference_code": "23PRC0000001"
},
{"id": 2,
"reference_code": "23PRC0000002"
}
],
"purchase_order": {"id": 123,
"items": [{"balance": "10.0",
"balance_shipped": "10.0",
"id": 123,
"line_number": 1,
"product": {"id": 2
},
"quantity": "20.0"
}
],
"necessity_date": "2023-10-29T00:00:00Z",
"supplier_expected_readiness_at": "2023-10-29T00:00:00Z",
"supplier_order_accepted_at": "2023-10-29T00:00:00Z",
"supplier_order_sent_at": "2023-10-29T00:00:00Z",
"supplier_readiness_at": "2023-10-29T00:00:00Z",
"type": "INDIRECT"
},
"reference_code": "23ORC0000001",
"subsidiary": {"id": 1,
"name": "Subsidiary"
},
"type": "PURCHASE"
}
}

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": {"canceled_at": "2019-08-24T14:15:22Z",
"id": 0
}
}

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": {"finished_at": "2019-08-24T14:15:22Z",
"id": 0
}
}

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": {"canceled_at": "2019-08-24T14:15:22Z",
"id": 0
}
}

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": [{"alert_level": "NORMAL",
"audit_items": [{"audit_item": {"id": 123,
"name": "Audit Item",
"show_observations_when": "ALWAYS"
},
"checked": true,
"id": 123,
"observations": "Erro de digitação na especificação do produto"
}
],
"canceled_at": null,
"deleted_at": null,
"extra_fields": { },
"finished_at": null,
"foreign_trade_shipment": {"air_transport_shipment": null,
"ata": "2023-10-29T00:00:00Z",
"atd": "2023-10-29T00:00:00Z",
"automatic_tracking_enabled": true,
"days_in_warehouse": 2,
"days_left_in_warehouse": 1,
"delivered_at": "2023-10-29T00:00:00Z",
"demurrage": {"daily_rate_usd": "10.5",
"free_time": 2,
"id": 1,
"total_demurrage_costs": "0"
},
"departed_from_warehouse_at": "2023-10-29T00:00:00Z",
"empty_return_date": "2023-10-29T00:00:00Z",
"eta": "2023-10-29T00:00:00Z",
"etd": "2023-10-29T00:00:00Z",
"id": 123,
"inserted_at": "2023-00-00T00:00:00Z",
"international_freight": {"currency": {"code": "USD",
"name": "US Dollar",
"symbol": "$"
},
"freight_forwarder": "ABC Shipping",
"id": 1,
"quotation_number": "Q123456",
"type": "PREPAID",
"value": "1250.00"
},
"invoices": [{"currency": {"code": "USD",
"name": "US Dollar",
"symbol": "$"
},
"emitted_at": "2023-11-04T10:00:00Z",
"id": 1,
"incoterm": "CPT",
"items": [{"batch_number": "BATCH-6789",
"id": 1,
"product_description": "Product A",
"product_sku": "SKU-12345",
"quantity": "5",
"shipment_quantity": 5,
"total_amount": "61.70",
"unitary_amount": "12.34"
}
],
"number": "INV-2023-001",
"total_amount": "1234.56",
"updated_at": "2023-11-04T14:30:00Z"
}
],
"items": [{"id": 123,
"purchase_order_item": {"balance": "10.0",
"balance_shipped": "10.0",
"id": 123,
"line_number": 1,
"product": {"id": 2
},
"quantity": "20.0"
},
"quantity": 10
}
],
"last_tracking_at": "2023-10-29T00:00:00Z",
"last_updated_at": "2023-10-29T00:00:00Z",
"maritime_transport_shipment": {"bl": "MEDUGB760924",
"booking": null,
"discharge_port": {"country": {"code": "BR",
"iso3": "BRA",
"name": "Brazil"
},
"id": 123,
"latitude": -23.951,
"longitude": -46.354,
"name": "Santos",
"unlocode": "BRSSZ"
},
"hbl": null,
"id": 123,
"loading_port": {"country": {"code": "CN",
"iso3": "CHN",
"name": "China"
},
"id": 1,
"latitude": -121.544,
"longitude": 29.868,
"name": "Ningbo",
"unlocode": "CNNGB"
},
"sealine": {"id": 1,
"logo_url": null,
"name": "Hamburg Sud",
"nickname": "Hamburg",
"scac": "SUDU",
"website": "https://www.hamburgsud.com/"
},
"tracking_discharge_port": "BRRIG",
"tracking_key": "BILL_OF_LADING",
"tracking_loading_port": "CNNGB",
"type": "FCL",
"valid_keys": ["BILL_OF_LADING"
],
"vessel": {"ais_class": "A",
"callsign": "VROL8",
"id": 123,
"imo_number": "9743265",
"mmsi_number": "538006242",
"name": "NEW ORLEANS",
"ship_sub_type": "AGGREGATES_CARRIER",
"ship_type": "ANTI_POLLUTION"
},
"voyage_number": "CNNGBTRB"
},
"national_road_transports": [{"collection_scheduled_at": "2023-10-29T00:00:00Z",
"delivery_planned_at": "2023-10-29T00:00:00Z",
"id": 1,
"is_transport_type_dta": true,
"leg_slug": "Porto>Armazem",
"load_type": "GENERAL_CARGO",
"quantity_pallets": 100,
"released_for_transport_at": "2023-10-29T00:00:00Z",
"road_transport_type": "LTL",
"route": {"active": true,
"id": 123,
"name": "Route A"
},
"transport_completed_at": "2023-10-29T00:00:00Z",
"transport_features": ["REFRIGERATED",
"HAZARDOUS_PRODUCTS"
],
"trips": [{"driver": {"birthday": "1990-01-15",
"country": {"code": "BR",
"iso3": "BRA",
"name": "Brazil"
},
"cpf": "12345678901",
"id": 123,
"license_category": "A",
"license_expiration_date": "2024-12-31",
"license_number": "DL12345",
"name": "John Doe",
"official_document": "ABC123XYZ"
},
"driver_name": "John Doe",
"id": 1,
"phases": [{"departure_at": "2023-10-29T00:00:00Z",
"estimated_realized_at": "2023-10-29T00:00:00Z",
"id": 1,
"realized_at": "2023-10-29T00:00:00Z",
"route_point": {"id": 123,
"position": 1,
"route_type": "LOADING"
}
}
],
"position": 123,
"trailer": null,
"trailer_plate": "XYZ456",
"transportables": [{"cargo": null,
"container": {"code": "MSDU5953962",
"id": 123
},
"id": 123,
"type": "container"
}
],
"vehicle": {"id": 123,
"is_refrigerated": true,
"plate": "ABC123",
"speed_limit_dry": 100,
"speed_limit_wet": 80,
"tare_weight_kg": "5000.0",
"temperature_max": 10,
"temperature_min": -20,
"tracker_brand": "SASCAR",
"tracker_id": 456,
"type": "TRUCK"
},
"vehicle_plate": "ABC123"
}
]
}
],
"received_in_warehouse_at": "2023-10-29T00:00:00Z",
"road_transport_shipment": null,
"route": {"active": true,
"id": 123,
"name": "Route A"
},
"shipment_import_declarations": [{"comments": "",
"id": 1,
"import_declaration": {"channel": "GREEN",
"customs_cleared_at": "2023-11-05T09:15:00Z",
"extra": "{}",
"id": 1,
"import_license": {"number": "2300000000"
},
"inserted_at": "2023-11-04T09:30:00Z",
"last_updated_at": "2023-11-04T14:30:00Z",
"number": "2212614470",
"registered_at": "2023-11-04T10:00:00Z",
"status": "CLEARED",
"status_response": "FOUND",
"status_updated_at": "2023-11-04T15:45:00Z"
},
"status": "AUTHORIZED"
}
],
"shipment_import_licenses": [{"comments": "",
"id": 1,
"import_license": {"approved_at": "2023-11-05T09:15:00Z",
"extra": "{}",
"id": 1,
"import_declaration": {"number": "2300000000"
},
"inserted_at": "2023-11-04T09:30:00Z",
"last_updated_at": "2023-11-04T14:30:00Z",
"number": "2212614470",
"registered_at": "2023-11-04T10:00:00Z",
"status": "CLEARED",
"status_response": "FOUND",
"status_updated_at": "2023-11-04T15:45:00Z"
},
"status": "AUTHORIZED"
}
],
"status_response": "FOUND",
"transportables": [{"cargo": null,
"container": {"actual_return_empty_container_at": "2023-00-00T00:00:00Z",
"code": "MSDU5953962",
"demurrage_costs": "10.10",
"estimated_return_empty_container_at": "2023-00-00T00:00:00Z",
"events": [{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "CNXIS",
"status": "Empty to Shipper",
"transport": null,
"voyage": "CNXISTRB"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "CNNGB",
"status": "Export received at CY",
"transport": null,
"voyage": "CNNGBTRB"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "CNNGB",
"status": "Export Loaded on Vessel",
"transport": "9484455",
"voyage": "CNNGBUX333A"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "DOCAU",
"status": "Full Transshipment Discharged",
"transport": "9484455",
"voyage": "DOCAUUX338R"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "DOCAU",
"status": "Full Transshipment Loaded",
"transport": "9299537",
"voyage": "DOCAUUA338A"
}
],
"gross_weight_kg": "100.10",
"hidden": false,
"id": 123,
"invoice_number": "99999",
"load_type": "GENERAL_CARGO",
"max_weight_kg": "100.123",
"seal_code": "SEAL_CODE",
"secondary_seal_code": "SECONDARY_SEAL_CODE",
"size_foot_type": "20_FOOT",
"tare_weight_kg": "100",
"tracking_api": true,
"tracking_manual": true,
"type": "DRY"
},
"id": 123,
"type": "container"
}
],
"type": "maritime_transport",
"warehouse_free_time_days": 1
},
"handlers": [{"actor": {"cnae": "",
"document_type": "CNPJ",
"id": 1,
"logo_url": null,
"nickname": "Nickname",
"official_document": "11111111111111",
"official_name": "Actor",
"opening_date": "2023-01-01",
"roles": ["CARGO_OWNER"
],
"trading_name": "Trading Name",
"verified": true
},
"business_unit": "Business Unit",
"id": 1,
"reference": "Handler Reference",
"secondary_reference": "Handler Secondary Reference"
}
],
"id": 123,
"inserted_at": "2023-10-29T00:00:00Z",
"lead_time_datetime_reference": "2023-10-29T00:00:00Z",
"orders": [{"id": 1
},
{"id": 2
}
],
"reference_code": "23PRC0000001"
}
]
}

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

Payload

Content type

application/json

{"params": {"alert_level": "NORMAL",
"extra_fields": { },
"foreign_trade_shipment": {"air_transport_shipment": null,
"ata": "2023-10-29T00:00:00Z",
"atd": "2023-10-29T00:00:00Z",
"automatic_tracking_enabled": true,
"delivered_at": "2023-10-29T00:00:00Z",
"demurrage": {"daily_rate_usd": "10.5",
"free_time": 2
},
"departed_from_warehouse_at": "2023-10-29T00:00:00Z",
"eta": "2023-10-29T00:00:00Z",
"etd": "2023-10-29T00:00:00Z",
"international_freight": {"currency_code": "USD",
"freight_forwarder": "ABC Shipping",
"quotation_number": "Q123456",
"type": "PREPAID",
"value": "1250.00"
},
"invoices": [{"currency_code": "USD",
"emitted_at": "2023-11-04T10:00:00Z",
"incoterm": "CPT",
"items": [{"batch_number": "BATCH-6789",
"product_description": "Product A",
"product_sku": "SKU-12345",
"quantity": "5",
"unitary_amount": "12.34"
}
],
"number": "INV-2023-001"
}
],
"items": [ ],
"maritime_transport_shipment": {"bl": "MEDUGB760924",
"booking": null,
"discharge_port_id": 2,
"hbl": null,
"loading_port_id": 1,
"sealine_id": null,
"tracking_discharge_port": "BRRIG",
"tracking_loading_port": "CNNGB",
"type": "FCL",
"vessel_id": null,
"voyage_number": "CNNGBTRB"
},
"national_road_transports": [{"collection_scheduled_at": "2023-10-29T00:00:00Z",
"delivery_planned_at": "2023-10-29T00:00:00Z",
"is_transport_type_dta": true,
"leg_slug": "Porto>Armazem",
"load_type": "GENERAL_CARGO",
"quantity_pallets": 100,
"released_for_transport_at": "2023-10-29T00:00:00Z",
"road_transport_type": "LTL",
"route_id": 1,
"transport_completed_at": "2023-10-29T00:00:00Z",
"transport_features": ["REFRIGERATED",
"HAZARDOUS_PRODUCTS"
],
"trips": [ ]
}
],
"received_in_warehouse_at": "2023-10-29T00:00:00Z",
"road_transport_shipment": null,
"route_id": 1,
"shipment_import_declarations": [{"comments": "",
"import_declaration": {"channel": "GREEN",
"customs_cleared_at": "2023-11-05T09:15:00Z",
"extra": "{}",
"last_updated_at": "2023-11-04T14:30:00Z",
"number": "2212614470",
"registered_at": "2023-11-04T10:00:00Z",
"status": "CLEARED",
"status_updated_at": "2023-11-04T15:45:00Z"
}
}
],
"shipment_import_licenses": [{"comments": "",
"import_license": {"approved_at": "2023-11-05T09:15:00Z",
"extra": "{}",
"last_updated_at": "2023-11-04T14:30:00Z",
"number": "2212614470",
"registered_at": "2023-11-04T10:00:00Z",
"status": "IN_ANALYSIS",
"status_updated_at": "2023-11-04T15:45:00Z"
}
}
],
"total_gross_weight": 1,
"total_net_weight": 1,
"transportables": [{"cargo": null,
"container": {"code": "MSDU5953962",
"gross_weight_kg": 100,
"hidden": false,
"invoice_number": "99999",
"load_type": "GENERAL_CARGO",
"max_weight_kg": 100,
"seal_code": "SEAL_CODE",
"secondary_seal_code": "SECONDARY_SEAL_CODE",
"size_foot_type": "HC_40",
"tare_weight_kg": 100,
"tracking_manual": true,
"type": "DRY"
}
}
],
"warehouse_free_time_days": 1
},
"handlers": [ ],
"lead_time_datetime_reference": "2023-10-29T00:00:00Z",
"order_ids": [ ],
"reference_code": "23PRC0000001"
}
}

Response samples

Content type

application/json

{"data": {"alert_level": "NORMAL",
"audit_items": [{"audit_item": {"id": 123,
"name": "Audit Item",
"show_observations_when": "ALWAYS"
},
"checked": true,
"id": 123,
"observations": "Erro de digitação na especificação do produto"
}
],
"canceled_at": null,
"deleted_at": null,
"extra_fields": { },
"finished_at": null,
"foreign_trade_shipment": {"air_transport_shipment": null,
"ata": "2023-10-29T00:00:00Z",
"atd": "2023-10-29T00:00:00Z",
"automatic_tracking_enabled": true,
"days_in_warehouse": 2,
"days_left_in_warehouse": 1,
"delivered_at": "2023-10-29T00:00:00Z",
"demurrage": {"daily_rate_usd": "10.5",
"free_time": 2,
"id": 1,
"total_demurrage_costs": "0"
},
"departed_from_warehouse_at": "2023-10-29T00:00:00Z",
"empty_return_date": "2023-10-29T00:00:00Z",
"eta": "2023-10-29T00:00:00Z",
"etd": "2023-10-29T00:00:00Z",
"id": 123,
"inserted_at": "2023-00-00T00:00:00Z",
"international_freight": {"currency": {"code": "USD",
"name": "US Dollar",
"symbol": "$"
},
"freight_forwarder": "ABC Shipping",
"id": 1,
"quotation_number": "Q123456",
"type": "PREPAID",
"value": "1250.00"
},
"invoices": [{"currency": {"code": "USD",
"name": "US Dollar",
"symbol": "$"
},
"emitted_at": "2023-11-04T10:00:00Z",
"id": 1,
"incoterm": "CPT",
"items": [{"batch_number": "BATCH-6789",
"id": 1,
"product_description": "Product A",
"product_sku": "SKU-12345",
"quantity": "5",
"shipment_quantity": 5,
"total_amount": "61.70",
"unitary_amount": "12.34"
}
],
"number": "INV-2023-001",
"total_amount": "1234.56",
"updated_at": "2023-11-04T14:30:00Z"
}
],
"items": [{"id": 123,
"purchase_order_item": {"balance": "10.0",
"balance_shipped": "10.0",
"id": 123,
"line_number": 1,
"product": {"id": 2
},
"quantity": "20.0"
},
"quantity": 10
}
],
"last_tracking_at": "2023-10-29T00:00:00Z",
"last_updated_at": "2023-10-29T00:00:00Z",
"maritime_transport_shipment": {"bl": "MEDUGB760924",
"booking": null,
"discharge_port": {"country": {"code": "BR",
"iso3": "BRA",
"name": "Brazil"
},
"id": 123,
"latitude": -23.951,
"longitude": -46.354,
"name": "Santos",
"unlocode": "BRSSZ"
},
"hbl": null,
"id": 123,
"loading_port": {"country": {"code": "CN",
"iso3": "CHN",
"name": "China"
},
"id": 1,
"latitude": -121.544,
"longitude": 29.868,
"name": "Ningbo",
"unlocode": "CNNGB"
},
"sealine": {"id": 1,
"logo_url": null,
"name": "Hamburg Sud",
"nickname": "Hamburg",
"scac": "SUDU",
"website": "https://www.hamburgsud.com/"
},
"tracking_discharge_port": "BRRIG",
"tracking_key": "BILL_OF_LADING",
"tracking_loading_port": "CNNGB",
"type": "FCL",
"valid_keys": ["BILL_OF_LADING"
],
"vessel": {"ais_class": "A",
"callsign": "VROL8",
"id": 123,
"imo_number": "9743265",
"mmsi_number": "538006242",
"name": "NEW ORLEANS",
"ship_sub_type": "AGGREGATES_CARRIER",
"ship_type": "ANTI_POLLUTION"
},
"voyage_number": "CNNGBTRB"
},
"national_road_transports": [{"collection_scheduled_at": "2023-10-29T00:00:00Z",
"delivery_planned_at": "2023-10-29T00:00:00Z",
"id": 1,
"is_transport_type_dta": true,
"leg_slug": "Porto>Armazem",
"load_type": "GENERAL_CARGO",
"quantity_pallets": 100,
"released_for_transport_at": "2023-10-29T00:00:00Z",
"road_transport_type": "LTL",
"route": {"active": true,
"id": 123,
"name": "Route A"
},
"transport_completed_at": "2023-10-29T00:00:00Z",
"transport_features": ["REFRIGERATED",
"HAZARDOUS_PRODUCTS"
],
"trips": [{"driver": {"birthday": "1990-01-15",
"country": {"code": "BR",
"iso3": "BRA",
"name": "Brazil"
},
"cpf": "12345678901",
"id": 123,
"license_category": "A",
"license_expiration_date": "2024-12-31",
"license_number": "DL12345",
"name": "John Doe",
"official_document": "ABC123XYZ"
},
"driver_name": "John Doe",
"id": 1,
"phases": [{"departure_at": "2023-10-29T00:00:00Z",
"estimated_realized_at": "2023-10-29T00:00:00Z",
"id": 1,
"realized_at": "2023-10-29T00:00:00Z",
"route_point": {"id": 123,
"position": 1,
"route_type": "LOADING"
}
}
],
"position": 123,
"trailer": null,
"trailer_plate": "XYZ456",
"transportables": [{"cargo": null,
"container": {"code": "MSDU5953962",
"id": 123
},
"id": 123,
"type": "container"
}
],
"vehicle": {"id": 123,
"is_refrigerated": true,
"plate": "ABC123",
"speed_limit_dry": 100,
"speed_limit_wet": 80,
"tare_weight_kg": "5000.0",
"temperature_max": 10,
"temperature_min": -20,
"tracker_brand": "SASCAR",
"tracker_id": 456,
"type": "TRUCK"
},
"vehicle_plate": "ABC123"
}
]
}
],
"received_in_warehouse_at": "2023-10-29T00:00:00Z",
"road_transport_shipment": null,
"route": {"active": true,
"id": 123,
"name": "Route A"
},
"shipment_import_declarations": [{"comments": "",
"id": 1,
"import_declaration": {"channel": "GREEN",
"customs_cleared_at": "2023-11-05T09:15:00Z",
"extra": "{}",
"id": 1,
"import_license": {"number": "2300000000"
},
"inserted_at": "2023-11-04T09:30:00Z",
"last_updated_at": "2023-11-04T14:30:00Z",
"number": "2212614470",
"registered_at": "2023-11-04T10:00:00Z",
"status": "CLEARED",
"status_response": "FOUND",
"status_updated_at": "2023-11-04T15:45:00Z"
},
"status": "AUTHORIZED"
}
],
"shipment_import_licenses": [{"comments": "",
"id": 1,
"import_license": {"approved_at": "2023-11-05T09:15:00Z",
"extra": "{}",
"id": 1,
"import_declaration": {"number": "2300000000"
},
"inserted_at": "2023-11-04T09:30:00Z",
"last_updated_at": "2023-11-04T14:30:00Z",
"number": "2212614470",
"registered_at": "2023-11-04T10:00:00Z",
"status": "CLEARED",
"status_response": "FOUND",
"status_updated_at": "2023-11-04T15:45:00Z"
},
"status": "AUTHORIZED"
}
],
"status_response": "FOUND",
"transportables": [{"cargo": null,
"container": {"actual_return_empty_container_at": "2023-00-00T00:00:00Z",
"code": "MSDU5953962",
"demurrage_costs": "10.10",
"estimated_return_empty_container_at": "2023-00-00T00:00:00Z",
"events": [{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "CNXIS",
"status": "Empty to Shipper",
"transport": null,
"voyage": "CNXISTRB"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "CNNGB",
"status": "Export received at CY",
"transport": null,
"voyage": "CNNGBTRB"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "CNNGB",
"status": "Export Loaded on Vessel",
"transport": "9484455",
"voyage": "CNNGBUX333A"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "DOCAU",
"status": "Full Transshipment Discharged",
"transport": "9484455",
"voyage": "DOCAUUX338R"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "DOCAU",
"status": "Full Transshipment Loaded",
"transport": "9299537",
"voyage": "DOCAUUA338A"
}
],
"gross_weight_kg": "100.10",
"hidden": false,
"id": 123,
"invoice_number": "99999",
"load_type": "GENERAL_CARGO",
"max_weight_kg": "100.123",
"seal_code": "SEAL_CODE",
"secondary_seal_code": "SECONDARY_SEAL_CODE",
"size_foot_type": "20_FOOT",
"tare_weight_kg": "100",
"tracking_api": true,
"tracking_manual": true,
"type": "DRY"
},
"id": 123,
"type": "container"
}
],
"type": "maritime_transport",
"warehouse_free_time_days": 1
},
"handlers": [{"actor": {"cnae": "",
"document_type": "CNPJ",
"id": 1,
"logo_url": null,
"nickname": "Nickname",
"official_document": "11111111111111",
"official_name": "Actor",
"opening_date": "2023-01-01",
"roles": ["CARGO_OWNER"
],
"trading_name": "Trading Name",
"verified": true
},
"business_unit": "Business Unit",
"id": 1,
"reference": "Handler Reference",
"secondary_reference": "Handler Secondary Reference"
}
],
"id": 123,
"inserted_at": "2023-10-29T00:00:00Z",
"lead_time_datetime_reference": "2023-10-29T00:00:00Z",
"orders": [{"id": 1
},
{"id": 2
}
],
"reference_code": "23PRC0000001"
}
}

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": {"deleted_at": "2019-08-24T14:15:22Z",
"id": 0
}
}

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": {"alert_level": "NORMAL",
"audit_items": [{"audit_item": {"id": 123,
"name": "Audit Item",
"show_observations_when": "ALWAYS"
},
"checked": true,
"id": 123,
"observations": "Erro de digitação na especificação do produto"
}
],
"canceled_at": null,
"deleted_at": null,
"extra_fields": { },
"finished_at": null,
"foreign_trade_shipment": {"air_transport_shipment": null,
"ata": "2023-10-29T00:00:00Z",
"atd": "2023-10-29T00:00:00Z",
"automatic_tracking_enabled": true,
"days_in_warehouse": 2,
"days_left_in_warehouse": 1,
"delivered_at": "2023-10-29T00:00:00Z",
"demurrage": {"daily_rate_usd": "10.5",
"free_time": 2,
"id": 1,
"total_demurrage_costs": "0"
},
"departed_from_warehouse_at": "2023-10-29T00:00:00Z",
"empty_return_date": "2023-10-29T00:00:00Z",
"eta": "2023-10-29T00:00:00Z",
"etd": "2023-10-29T00:00:00Z",
"id": 123,
"inserted_at": "2023-00-00T00:00:00Z",
"international_freight": {"currency": {"code": "USD",
"name": "US Dollar",
"symbol": "$"
},
"freight_forwarder": "ABC Shipping",
"id": 1,
"quotation_number": "Q123456",
"type": "PREPAID",
"value": "1250.00"
},
"invoices": [{"currency": {"code": "USD",
"name": "US Dollar",
"symbol": "$"
},
"emitted_at": "2023-11-04T10:00:00Z",
"id": 1,
"incoterm": "CPT",
"items": [{"batch_number": "BATCH-6789",
"id": 1,
"product_description": "Product A",
"product_sku": "SKU-12345",
"quantity": "5",
"shipment_quantity": 5,
"total_amount": "61.70",
"unitary_amount": "12.34"
}
],
"number": "INV-2023-001",
"total_amount": "1234.56",
"updated_at": "2023-11-04T14:30:00Z"
}
],
"items": [{"id": 123,
"purchase_order_item": {"balance": "10.0",
"balance_shipped": "10.0",
"id": 123,
"line_number": 1,
"product": {"id": 2
},
"quantity": "20.0"
},
"quantity": 10
}
],
"last_tracking_at": "2023-10-29T00:00:00Z",
"last_updated_at": "2023-10-29T00:00:00Z",
"maritime_transport_shipment": {"bl": "MEDUGB760924",
"booking": null,
"discharge_port": {"country": {"code": "BR",
"iso3": "BRA",
"name": "Brazil"
},
"id": 123,
"latitude": -23.951,
"longitude": -46.354,
"name": "Santos",
"unlocode": "BRSSZ"
},
"hbl": null,
"id": 123,
"loading_port": {"country": {"code": "CN",
"iso3": "CHN",
"name": "China"
},
"id": 1,
"latitude": -121.544,
"longitude": 29.868,
"name": "Ningbo",
"unlocode": "CNNGB"
},
"sealine": {"id": 1,
"logo_url": null,
"name": "Hamburg Sud",
"nickname": "Hamburg",
"scac": "SUDU",
"website": "https://www.hamburgsud.com/"
},
"tracking_discharge_port": "BRRIG",
"tracking_key": "BILL_OF_LADING",
"tracking_loading_port": "CNNGB",
"type": "FCL",
"valid_keys": ["BILL_OF_LADING"
],
"vessel": {"ais_class": "A",
"callsign": "VROL8",
"id": 123,
"imo_number": "9743265",
"mmsi_number": "538006242",
"name": "NEW ORLEANS",
"ship_sub_type": "AGGREGATES_CARRIER",
"ship_type": "ANTI_POLLUTION"
},
"voyage_number": "CNNGBTRB"
},
"national_road_transports": [{"collection_scheduled_at": "2023-10-29T00:00:00Z",
"delivery_planned_at": "2023-10-29T00:00:00Z",
"id": 1,
"is_transport_type_dta": true,
"leg_slug": "Porto>Armazem",
"load_type": "GENERAL_CARGO",
"quantity_pallets": 100,
"released_for_transport_at": "2023-10-29T00:00:00Z",
"road_transport_type": "LTL",
"route": {"active": true,
"id": 123,
"name": "Route A"
},
"transport_completed_at": "2023-10-29T00:00:00Z",
"transport_features": ["REFRIGERATED",
"HAZARDOUS_PRODUCTS"
],
"trips": [{"driver": {"birthday": "1990-01-15",
"country": {"code": "BR",
"iso3": "BRA",
"name": "Brazil"
},
"cpf": "12345678901",
"id": 123,
"license_category": "A",
"license_expiration_date": "2024-12-31",
"license_number": "DL12345",
"name": "John Doe",
"official_document": "ABC123XYZ"
},
"driver_name": "John Doe",
"id": 1,
"phases": [{"departure_at": "2023-10-29T00:00:00Z",
"estimated_realized_at": "2023-10-29T00:00:00Z",
"id": 1,
"realized_at": "2023-10-29T00:00:00Z",
"route_point": {"id": 123,
"position": 1,
"route_type": "LOADING"
}
}
],
"position": 123,
"trailer": null,
"trailer_plate": "XYZ456",
"transportables": [{"cargo": null,
"container": {"code": "MSDU5953962",
"id": 123
},
"id": 123,
"type": "container"
}
],
"vehicle": {"id": 123,
"is_refrigerated": true,
"plate": "ABC123",
"speed_limit_dry": 100,
"speed_limit_wet": 80,
"tare_weight_kg": "5000.0",
"temperature_max": 10,
"temperature_min": -20,
"tracker_brand": "SASCAR",
"tracker_id": 456,
"type": "TRUCK"
},
"vehicle_plate": "ABC123"
}
]
}
],
"received_in_warehouse_at": "2023-10-29T00:00:00Z",
"road_transport_shipment": null,
"route": {"active": true,
"id": 123,
"name": "Route A"
},
"shipment_import_declarations": [{"comments": "",
"id": 1,
"import_declaration": {"channel": "GREEN",
"customs_cleared_at": "2023-11-05T09:15:00Z",
"extra": "{}",
"id": 1,
"import_license": {"number": "2300000000"
},
"inserted_at": "2023-11-04T09:30:00Z",
"last_updated_at": "2023-11-04T14:30:00Z",
"number": "2212614470",
"registered_at": "2023-11-04T10:00:00Z",
"status": "CLEARED",
"status_response": "FOUND",
"status_updated_at": "2023-11-04T15:45:00Z"
},
"status": "AUTHORIZED"
}
],
"shipment_import_licenses": [{"comments": "",
"id": 1,
"import_license": {"approved_at": "2023-11-05T09:15:00Z",
"extra": "{}",
"id": 1,
"import_declaration": {"number": "2300000000"
},
"inserted_at": "2023-11-04T09:30:00Z",
"last_updated_at": "2023-11-04T14:30:00Z",
"number": "2212614470",
"registered_at": "2023-11-04T10:00:00Z",
"status": "CLEARED",
"status_response": "FOUND",
"status_updated_at": "2023-11-04T15:45:00Z"
},
"status": "AUTHORIZED"
}
],
"status_response": "FOUND",
"transportables": [{"cargo": null,
"container": {"actual_return_empty_container_at": "2023-00-00T00:00:00Z",
"code": "MSDU5953962",
"demurrage_costs": "10.10",
"estimated_return_empty_container_at": "2023-00-00T00:00:00Z",
"events": [{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "CNXIS",
"status": "Empty to Shipper",
"transport": null,
"voyage": "CNXISTRB"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "CNNGB",
"status": "Export received at CY",
"transport": null,
"voyage": "CNNGBTRB"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "CNNGB",
"status": "Export Loaded on Vessel",
"transport": "9484455",
"voyage": "CNNGBUX333A"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "DOCAU",
"status": "Full Transshipment Discharged",
"transport": "9484455",
"voyage": "DOCAUUX338R"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "DOCAU",
"status": "Full Transshipment Loaded",
"transport": "9299537",
"voyage": "DOCAUUA338A"
}
],
"gross_weight_kg": "100.10",
"hidden": false,
"id": 123,
"invoice_number": "99999",
"load_type": "GENERAL_CARGO",
"max_weight_kg": "100.123",
"seal_code": "SEAL_CODE",
"secondary_seal_code": "SECONDARY_SEAL_CODE",
"size_foot_type": "20_FOOT",
"tare_weight_kg": "100",
"tracking_api": true,
"tracking_manual": true,
"type": "DRY"
},
"id": 123,
"type": "container"
}
],
"type": "maritime_transport",
"warehouse_free_time_days": 1
},
"handlers": [{"actor": {"cnae": "",
"document_type": "CNPJ",
"id": 1,
"logo_url": null,
"nickname": "Nickname",
"official_document": "11111111111111",
"official_name": "Actor",
"opening_date": "2023-01-01",
"roles": ["CARGO_OWNER"
],
"trading_name": "Trading Name",
"verified": true
},
"business_unit": "Business Unit",
"id": 1,
"reference": "Handler Reference",
"secondary_reference": "Handler Secondary Reference"
}
],
"id": 123,
"inserted_at": "2023-10-29T00:00:00Z",
"lead_time_datetime_reference": "2023-10-29T00:00:00Z",
"orders": [{"id": 1
},
{"id": 2
}
],
"reference_code": "23PRC0000001"
}
}

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

Payload

Content type

application/json

{"params": {"alert_level": "NORMAL",
"extra_fields": { },
"foreign_trade_shipment": {"air_transport_shipment": null,
"ata": "2023-10-29T00:00:00Z",
"atd": "2023-10-29T00:00:00Z",
"automatic_tracking_enabled": true,
"delivered_at": "2023-10-29T00:00:00Z",
"demurrage": {"daily_rate_usd": "10.5",
"free_time": 2
},
"departed_from_warehouse_at": "2023-10-29T00:00:00Z",
"eta": "2023-10-29T00:00:00Z",
"etd": "2023-10-29T00:00:00Z",
"international_freight": {"currency_code": "USD",
"freight_forwarder": "ABC Shipping",
"quotation_number": "Q123456",
"type": "PREPAID",
"value": "1250.00"
},
"invoices": [{"currency_code": "USD",
"emitted_at": "2023-11-04T10:00:00Z",
"incoterm": "CPT",
"items": [{"batch_number": "BATCH-6789",
"product_description": "Product A",
"product_sku": "SKU-12345",
"quantity": "5",
"unitary_amount": "12.34"
}
],
"number": "INV-2023-001"
}
],
"items": [ ],
"maritime_transport_shipment": {"bl": "MEDUGB760924",
"booking": null,
"discharge_port_id": 2,
"hbl": null,
"loading_port_id": 1,
"sealine_id": null,
"tracking_discharge_port": "BRRIG",
"tracking_loading_port": "CNNGB",
"type": "FCL",
"vessel_id": null,
"voyage_number": "CNNGBTRB"
},
"national_road_transports": [{"collection_scheduled_at": "2023-10-29T00:00:00Z",
"delivery_planned_at": "2023-10-29T00:00:00Z",
"is_transport_type_dta": true,
"leg_slug": "Porto>Armazem",
"load_type": "GENERAL_CARGO",
"quantity_pallets": 100,
"released_for_transport_at": "2023-10-29T00:00:00Z",
"road_transport_type": "LTL",
"route_id": 1,
"transport_completed_at": "2023-10-29T00:00:00Z",
"transport_features": ["REFRIGERATED",
"HAZARDOUS_PRODUCTS"
],
"trips": [ ]
}
],
"received_in_warehouse_at": "2023-10-29T00:00:00Z",
"road_transport_shipment": null,
"route_id": 1,
"shipment_import_declarations": [{"comments": "",
"id": 1,
"import_declaration": {"channel": "GREEN",
"customs_cleared_at": "2023-11-05T09:15:00Z",
"extra": "{}",
"last_updated_at": "2023-11-04T14:30:00Z",
"number": "2212614470",
"registered_at": "2023-11-04T10:00:00Z",
"status": "CLEARED",
"status_updated_at": "2023-11-04T15:45:00Z"
}
}
],
"shipment_import_licenses": [{"comments": "",
"id": 1,
"import_license": {"approved_at": "2023-11-05T09:15:00Z",
"extra": "{}",
"last_updated_at": "2023-11-04T14:30:00Z",
"number": "2212614470",
"registered_at": "2023-11-04T10:00:00Z",
"status": "IN_ANALYSIS",
"status_updated_at": "2023-11-04T15:45:00Z"
}
}
],
"total_gross_weight": 1,
"total_net_weight": 1,
"transportables": [{"cargo": null,
"container": {"code": "MSDU5953962",
"gross_weight_kg": 100,
"hidden": false,
"invoice_number": "99999",
"load_type": "GENERAL_CARGO",
"max_weight_kg": 100,
"seal_code": "SEAL_CODE",
"secondary_seal_code": "SECONDARY_SEAL_CODE",
"size_foot_type": "HC_40",
"tare_weight_kg": 100,
"tracking_manual": true,
"type": "DRY"
}
}
],
"warehouse_free_time_days": 1
},
"handlers": [ ],
"lead_time_datetime_reference": "2023-10-29T00:00:00Z",
"order_ids": [ ]
}
}

Response samples

Content type

application/json

{"data": {"alert_level": "NORMAL",
"audit_items": [{"audit_item": {"id": 123,
"name": "Audit Item",
"show_observations_when": "ALWAYS"
},
"checked": true,
"id": 123,
"observations": "Erro de digitação na especificação do produto"
}
],
"canceled_at": null,
"deleted_at": null,
"extra_fields": { },
"finished_at": null,
"foreign_trade_shipment": {"air_transport_shipment": null,
"ata": "2023-10-29T00:00:00Z",
"atd": "2023-10-29T00:00:00Z",
"automatic_tracking_enabled": true,
"days_in_warehouse": 2,
"days_left_in_warehouse": 1,
"delivered_at": "2023-10-29T00:00:00Z",
"demurrage": {"daily_rate_usd": "10.5",
"free_time": 2,
"id": 1,
"total_demurrage_costs": "0"
},
"departed_from_warehouse_at": "2023-10-29T00:00:00Z",
"empty_return_date": "2023-10-29T00:00:00Z",
"eta": "2023-10-29T00:00:00Z",
"etd": "2023-10-29T00:00:00Z",
"id": 123,
"inserted_at": "2023-00-00T00:00:00Z",
"international_freight": {"currency": {"code": "USD",
"name": "US Dollar",
"symbol": "$"
},
"freight_forwarder": "ABC Shipping",
"id": 1,
"quotation_number": "Q123456",
"type": "PREPAID",
"value": "1250.00"
},
"invoices": [{"currency": {"code": "USD",
"name": "US Dollar",
"symbol": "$"
},
"emitted_at": "2023-11-04T10:00:00Z",
"id": 1,
"incoterm": "CPT",
"items": [{"batch_number": "BATCH-6789",
"id": 1,
"product_description": "Product A",
"product_sku": "SKU-12345",
"quantity": "5",
"shipment_quantity": 5,
"total_amount": "61.70",
"unitary_amount": "12.34"
}
],
"number": "INV-2023-001",
"total_amount": "1234.56",
"updated_at": "2023-11-04T14:30:00Z"
}
],
"items": [{"id": 123,
"purchase_order_item": {"balance": "10.0",
"balance_shipped": "10.0",
"id": 123,
"line_number": 1,
"product": {"id": 2
},
"quantity": "20.0"
},
"quantity": 10
}
],
"last_tracking_at": "2023-10-29T00:00:00Z",
"last_updated_at": "2023-10-29T00:00:00Z",
"maritime_transport_shipment": {"bl": "MEDUGB760924",
"booking": null,
"discharge_port": {"country": {"code": "BR",
"iso3": "BRA",
"name": "Brazil"
},
"id": 123,
"latitude": -23.951,
"longitude": -46.354,
"name": "Santos",
"unlocode": "BRSSZ"
},
"hbl": null,
"id": 123,
"loading_port": {"country": {"code": "CN",
"iso3": "CHN",
"name": "China"
},
"id": 1,
"latitude": -121.544,
"longitude": 29.868,
"name": "Ningbo",
"unlocode": "CNNGB"
},
"sealine": {"id": 1,
"logo_url": null,
"name": "Hamburg Sud",
"nickname": "Hamburg",
"scac": "SUDU",
"website": "https://www.hamburgsud.com/"
},
"tracking_discharge_port": "BRRIG",
"tracking_key": "BILL_OF_LADING",
"tracking_loading_port": "CNNGB",
"type": "FCL",
"valid_keys": ["BILL_OF_LADING"
],
"vessel": {"ais_class": "A",
"callsign": "VROL8",
"id": 123,
"imo_number": "9743265",
"mmsi_number": "538006242",
"name": "NEW ORLEANS",
"ship_sub_type": "AGGREGATES_CARRIER",
"ship_type": "ANTI_POLLUTION"
},
"voyage_number": "CNNGBTRB"
},
"national_road_transports": [{"collection_scheduled_at": "2023-10-29T00:00:00Z",
"delivery_planned_at": "2023-10-29T00:00:00Z",
"id": 1,
"is_transport_type_dta": true,
"leg_slug": "Porto>Armazem",
"load_type": "GENERAL_CARGO",
"quantity_pallets": 100,
"released_for_transport_at": "2023-10-29T00:00:00Z",
"road_transport_type": "LTL",
"route": {"active": true,
"id": 123,
"name": "Route A"
},
"transport_completed_at": "2023-10-29T00:00:00Z",
"transport_features": ["REFRIGERATED",
"HAZARDOUS_PRODUCTS"
],
"trips": [{"driver": {"birthday": "1990-01-15",
"country": {"code": "BR",
"iso3": "BRA",
"name": "Brazil"
},
"cpf": "12345678901",
"id": 123,
"license_category": "A",
"license_expiration_date": "2024-12-31",
"license_number": "DL12345",
"name": "John Doe",
"official_document": "ABC123XYZ"
},
"driver_name": "John Doe",
"id": 1,
"phases": [{"departure_at": "2023-10-29T00:00:00Z",
"estimated_realized_at": "2023-10-29T00:00:00Z",
"id": 1,
"realized_at": "2023-10-29T00:00:00Z",
"route_point": {"id": 123,
"position": 1,
"route_type": "LOADING"
}
}
],
"position": 123,
"trailer": null,
"trailer_plate": "XYZ456",
"transportables": [{"cargo": null,
"container": {"code": "MSDU5953962",
"id": 123
},
"id": 123,
"type": "container"
}
],
"vehicle": {"id": 123,
"is_refrigerated": true,
"plate": "ABC123",
"speed_limit_dry": 100,
"speed_limit_wet": 80,
"tare_weight_kg": "5000.0",
"temperature_max": 10,
"temperature_min": -20,
"tracker_brand": "SASCAR",
"tracker_id": 456,
"type": "TRUCK"
},
"vehicle_plate": "ABC123"
}
]
}
],
"received_in_warehouse_at": "2023-10-29T00:00:00Z",
"road_transport_shipment": null,
"route": {"active": true,
"id": 123,
"name": "Route A"
},
"shipment_import_declarations": [{"comments": "",
"id": 1,
"import_declaration": {"channel": "GREEN",
"customs_cleared_at": "2023-11-05T09:15:00Z",
"extra": "{}",
"id": 1,
"import_license": {"number": "2300000000"
},
"inserted_at": "2023-11-04T09:30:00Z",
"last_updated_at": "2023-11-04T14:30:00Z",
"number": "2212614470",
"registered_at": "2023-11-04T10:00:00Z",
"status": "CLEARED",
"status_response": "FOUND",
"status_updated_at": "2023-11-04T15:45:00Z"
},
"status": "AUTHORIZED"
}
],
"shipment_import_licenses": [{"comments": "",
"id": 1,
"import_license": {"approved_at": "2023-11-05T09:15:00Z",
"extra": "{}",
"id": 1,
"import_declaration": {"number": "2300000000"
},
"inserted_at": "2023-11-04T09:30:00Z",
"last_updated_at": "2023-11-04T14:30:00Z",
"number": "2212614470",
"registered_at": "2023-11-04T10:00:00Z",
"status": "CLEARED",
"status_response": "FOUND",
"status_updated_at": "2023-11-04T15:45:00Z"
},
"status": "AUTHORIZED"
}
],
"status_response": "FOUND",
"transportables": [{"cargo": null,
"container": {"actual_return_empty_container_at": "2023-00-00T00:00:00Z",
"code": "MSDU5953962",
"demurrage_costs": "10.10",
"estimated_return_empty_container_at": "2023-00-00T00:00:00Z",
"events": [{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "CNXIS",
"status": "Empty to Shipper",
"transport": null,
"voyage": "CNXISTRB"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "CNNGB",
"status": "Export received at CY",
"transport": null,
"voyage": "CNNGBTRB"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "CNNGB",
"status": "Export Loaded on Vessel",
"transport": "9484455",
"voyage": "CNNGBUX333A"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "DOCAU",
"status": "Full Transshipment Discharged",
"transport": "9484455",
"voyage": "DOCAUUX338R"
},
{"datetime": "2023-00-00T00:00:00Z",
"estimated": false,
"place": "DOCAU",
"status": "Full Transshipment Loaded",
"transport": "9299537",
"voyage": "DOCAUUA338A"
}
],
"gross_weight_kg": "100.10",
"hidden": false,
"id": 123,
"invoice_number": "99999",
"load_type": "GENERAL_CARGO",
"max_weight_kg": "100.123",
"seal_code": "SEAL_CODE",
"secondary_seal_code": "SECONDARY_SEAL_CODE",
"size_foot_type": "20_FOOT",
"tare_weight_kg": "100",
"tracking_api": true,
"tracking_manual": true,
"type": "DRY"
},
"id": 123,
"type": "container"
}
],
"type": "maritime_transport",
"warehouse_free_time_days": 1
},
"handlers": [{"actor": {"cnae": "",
"document_type": "CNPJ",
"id": 1,
"logo_url": null,
"nickname": "Nickname",
"official_document": "11111111111111",
"official_name": "Actor",
"opening_date": "2023-01-01",
"roles": ["CARGO_OWNER"
],
"trading_name": "Trading Name",
"verified": true
},
"business_unit": "Business Unit",
"id": 1,
"reference": "Handler Reference",
"secondary_reference": "Handler Secondary Reference"
}
],
"id": 123,
"inserted_at": "2023-10-29T00:00:00Z",
"lead_time_datetime_reference": "2023-10-29T00:00:00Z",
"orders": [{"id": 1
},
{"id": 2
}
],
"reference_code": "23PRC0000001"
}
}

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": {"canceled_at": "2019-08-24T14:15:22Z",
"id": 0
}
}

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": {"finished_at": "2019-08-24T14:15:22Z",
"id": 0
}
}

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": {"canceled_at": "2019-08-24T14:15:22Z",
"id": 0
}
}

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": [{"c9_ratio": null,
"category": "Suspension",
"code": "REF1234",
"description": "Shock Absorbers",
"extra": null,
"family": "Suspension and Handling",
"id": 123,
"internal_codes": [{"code": "REF5678",
"id": 1,
"label": "Client internal code"
},
{"code": "CODE-2",
"id": 1,
"label": "Supplier code"
}
],
"manufacturer": "Schneider-Rutherford",
"mercosul_code": "8708.80.00",
"multiple_package_capacity": "30",
"multiple_package_measurement_unit": "BOXES",
"package_capacity": "4",
"package_code": "PR017",
"package_measurement_unit": "PAIRS",
"product_foreign_operators": [{"cnae": "",
"document_type": "CNPJ",
"id": 1,
"logo_url": null,
"nickname": "Nickname",
"official_document": "11111111111111",
"official_name": "Actor",
"opening_date": "2023-01-01",
"roles": ["CARGO_OWNER"
],
"trading_name": "Trading Name",
"verified": true
}
]
}
]
}

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

Payload

Content type

application/json

{"params": {"c9_ratio": null,
"category": "Suspension",
"code": "REF1234",
"description": "Shock Absorbers",
"extra": null,
"family": "Suspension and Handling",
"internal_codes": [{"code": "REF5678",
"label": "Client internal code"
},
{"code": "CODE-2",
"label": "Supplier code"
}
],
"manufacturer": "Schneider-Rutherford",
"mercosul_code": "8708.80.00",
"multiple_package_capacity": "30",
"multiple_package_measurement_unit": "BOXES",
"package_capacity": "4",
"package_code": "PR017",
"package_measurement_unit": "PAIRS",
"product_foreign_operators": [ ]
}
}

Response samples

Content type

application/json

{"data": {"c9_ratio": null,
"category": "Suspension",
"code": "REF1234",
"description": "Shock Absorbers",
"extra": null,
"family": "Suspension and Handling",
"id": 123,
"internal_codes": [{"code": "REF5678",
"id": 1,
"label": "Client internal code"
},
{"code": "CODE-2",
"id": 1,
"label": "Supplier code"
}
],
"manufacturer": "Schneider-Rutherford",
"mercosul_code": "8708.80.00",
"multiple_package_capacity": "30",
"multiple_package_measurement_unit": "BOXES",
"package_capacity": "4",
"package_code": "PR017",
"package_measurement_unit": "PAIRS",
"product_foreign_operators": [{"cnae": "",
"document_type": "CNPJ",
"id": 1,
"logo_url": null,
"nickname": "Nickname",
"official_document": "11111111111111",
"official_name": "Actor",
"opening_date": "2023-01-01",
"roles": ["CARGO_OWNER"
],
"trading_name": "Trading Name",
"verified": true
}
]
}
}

Delete a Product

Authorizations:

api-key

path Parameters

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": {"c9_ratio": null,
"category": "Suspension",
"code": "REF1234",
"description": "Shock Absorbers",
"extra": null,
"family": "Suspension and Handling",
"id": 123,
"internal_codes": [{"code": "REF5678",
"id": 1,
"label": "Client internal code"
},
{"code": "CODE-2",
"id": 1,
"label": "Supplier code"
}
],
"manufacturer": "Schneider-Rutherford",
"mercosul_code": "8708.80.00",
"multiple_package_capacity": "30",
"multiple_package_measurement_unit": "BOXES",
"package_capacity": "4",
"package_code": "PR017",
"package_measurement_unit": "PAIRS",
"product_foreign_operators": [{"cnae": "",
"document_type": "CNPJ",
"id": 1,
"logo_url": null,
"nickname": "Nickname",
"official_document": "11111111111111",
"official_name": "Actor",
"opening_date": "2023-01-01",
"roles": ["CARGO_OWNER"
],
"trading_name": "Trading Name",
"verified": true
}
]
}
}

Get a Product

Authorizations:

api-key

path Parameters

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": {"c9_ratio": null,
"category": "Suspension",
"code": "REF1234",
"description": "Shock Absorbers",
"extra": null,
"family": "Suspension and Handling",
"id": 123,
"internal_codes": [{"code": "REF5678",
"id": 1,
"label": "Client internal code"
},
{"code": "CODE-2",
"id": 1,
"label": "Supplier code"
}
],
"manufacturer": "Schneider-Rutherford",
"mercosul_code": "8708.80.00",
"multiple_package_capacity": "30",
"multiple_package_measurement_unit": "BOXES",
"package_capacity": "4",
"package_code": "PR017",
"package_measurement_unit": "PAIRS",
"product_foreign_operators": [{"cnae": "",
"document_type": "CNPJ",
"id": 1,
"logo_url": null,
"nickname": "Nickname",
"official_document": "11111111111111",
"official_name": "Actor",
"opening_date": "2023-01-01",
"roles": ["CARGO_OWNER"
],
"trading_name": "Trading Name",
"verified": true
}
]
}
}

Update a Product

Authorizations:

api-key

path Parameters

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

Payload

Content type

application/json

{"params": {"c9_ratio": null,
"category": "Suspension",
"code": "REF1234",
"description": "Shock Absorbers",
"extra": null,
"family": "Suspension and Handling",
"internal_codes": [{"code": "REF5678",
"label": "Client internal code"
},
{"code": "CODE-2",
"label": "Supplier code"
}
],
"manufacturer": "Schneider-Rutherford",
"mercosul_code": "8708.80.00",
"multiple_package_capacity": "30",
"multiple_package_measurement_unit": "BOXES",
"package_capacity": "4",
"package_code": "PR017",
"package_measurement_unit": "PAIRS",
"product_foreign_operators": [ ]
}
}

Response samples

Content type

application/json

{"data": {"c9_ratio": null,
"category": "Suspension",
"code": "REF1234",
"description": "Shock Absorbers",
"extra": null,
"family": "Suspension and Handling",
"id": 123,
"internal_codes": [{"code": "REF5678",
"id": 1,
"label": "Client internal code"
},
{"code": "CODE-2",
"id": 1,
"label": "Supplier code"
}
],
"manufacturer": "Schneider-Rutherford",
"mercosul_code": "8708.80.00",
"multiple_package_capacity": "30",
"multiple_package_measurement_unit": "BOXES",
"package_capacity": "4",
"package_code": "PR017",
"package_measurement_unit": "PAIRS",
"product_foreign_operators": [{"cnae": "",
"document_type": "CNPJ",
"id": 1,
"logo_url": null,
"nickname": "Nickname",
"official_document": "11111111111111",
"official_name": "Actor",
"opening_date": "2023-01-01",
"roles": ["CARGO_OWNER"
],
"trading_name": "Trading Name",
"verified": true
}
]
}
}

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

Payload

Content type

application/json

{"params": [{"params": {"c9_ratio": null,
"category": "Suspension",
"code": "REF1234",
"description": "Shock Absorbers",
"extra": null,
"family": "Suspension and Handling",
"internal_codes": [{"code": "REF5678",
"label": "Client internal code"
},
{"code": "CODE-2",
"label": "Supplier code"
}
],
"manufacturer": "Schneider-Rutherford",
"mercosul_code": "8708.80.00",
"multiple_package_capacity": "30",
"multiple_package_measurement_unit": "BOXES",
"package_capacity": "4",
"package_code": "PR017",
"package_measurement_unit": "PAIRS",
"product_foreign_operators": [ ]
}
}
]
}

Response samples

Content type

application/json

{"data": [{"c9_ratio": null,
"category": "Suspension",
"code": "REF1234",
"description": "Shock Absorbers",
"extra": null,
"family": "Suspension and Handling",
"id": 123,
"internal_codes": [{"code": "REF5678",
"id": 1,
"label": "Client internal code"
},
{"code": "CODE-2",
"id": 1,
"label": "Supplier code"
}
],
"manufacturer": "Schneider-Rutherford",
"mercosul_code": "8708.80.00",
"multiple_package_capacity": "30",
"multiple_package_measurement_unit": "BOXES",
"package_capacity": "4",
"package_code": "PR017",
"package_measurement_unit": "PAIRS",
"product_foreign_operators": [{"cnae": "",
"document_type": "CNPJ",
"id": 1,
"logo_url": null,
"nickname": "Nickname",
"official_document": "11111111111111",
"official_name": "Actor",
"opening_date": "2023-01-01",
"roles": ["CARGO_OWNER"
],
"trading_name": "Trading Name",
"verified": true
}
]
}
]
}

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": [{"atb": "2024-02-25T08:30:00Z",
"atu": null,
"carrier_code": "98765432109876",
"carrier_country": {"code": "US",
"iso3": "USA",
"name": "United States"
},
"carrier_name": "Example Carrier",
"carrier_voyage": "Voyage123",
"etb": "2024-02-25T08:00:00Z",
"etu": "2024-02-30T16:00:00Z",
"last_ports": [{"atu": "2024-02-25T17:00:00Z",
"port_unlocode": "BRSSZ"
},
{"atu": "2024-03-01T17:00:00Z",
"port_unlocode": "BRSSA"
}
],
"next_ports": [{"etb": "2024-03-20T08:00:00Z",
"port_unlocode": "BRSSO"
}
],
"operation_type": "Carga",
"schedule_number": "PS001",
"shipping_agency_cnpj": "12345678901234",
"shipping_agency_name": "Example Shipping Agency",
"vessel": {"ais_class": "A",
"callsign": "VROL8",
"country": {"code": "US",
"iso3": "USA",
"name": "United States"
},
"dimensions": {"a": 124,
"b": 176,
"c": 15,
"d": 33,
"length": 272,
"width": 40
},
"id": 123,
"imo_number": "9743265",
"mmsi_number": "538006242",
"name": "NEW ORLEANS",
"ship_sub_type": "AGGREGATES_CARRIER",
"ship_type": "ANTI_POLLUTION"
},
"vessel_responsible": "MASTER"
}
],
"total_count": 0
}