{"components":{"parameters":{"locale":{"description":"The 'locale' parameter allows specify the desired language for translating messages returned by the Server.","in":"header","name":"locale","schema":{"default":"pt-BR","enum":["pt-BR","en-US","es-ES"],"example":"pt-BR","type":"string"}},"pagination":{"description":"Parameter for controlling pagination of the result set.","explode":true,"in":"query","name":"pagination","schema":{"properties":{"limit":{"default":20,"description":"The maximum number of items to return per page.","maximum":100,"minimum":1,"type":"integer"},"offset":{"default":0,"description":"The number of items to skip before starting to collect the result set.","minimum":0,"type":"integer"},"order_by":{"items":{"example":{"field":"ID","order":"ASC"},"properties":{"field":{"description":"Field to be considered when sorting, `use Uppercase`.","type":"string"},"order":{"description":"The sort order for the result set.","enum":["ASC","ASC_NULLS_LAST","ASC_NULLS_FIRST","DESC","DESC_NULLS_LAST","DESC_NULLS_FIRST"],"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"style":"deepObject"}},"responses":{"bad_request":{"content":{"application/json":{"example":{"code":"BAD_REQUEST","fields":[{"message":"field: can't be blank","name":"field"},{"message":"field_2: can't be blank","name":"field_2"}],"message":"One or more fields are invalid. Please fill in correctly and try again."},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request Response"},"internal_server_error":{"content":{"application/json":{"example":{"code":"INTERNAL_SERVER_ERROR","message":"Provided data are invalid."},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error Response"},"not_found":{"content":{"application/json":{"example":{"code":"NOT_FOUND","message":"Resource not found."},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found Response"},"unauthorized":{"content":{"application/json":{"example":{"code":"UNAUTHORIZED","message":"Unauthorized to access this resource."},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized Response"},"unprocessable_entity":{"content":{"application/json":{"example":{"code":"UNPROCESSABLE_ENTITY","message":"Provided data are invalid."},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unprocessable Entity Response"}},"schemas":{"CostModelVersionMinimalObject":{"description":"This schema defines an 'Cost Model Version' data structure.","example":{"cost_model":{"id":123,"name":"Cost Model"},"id":123,"version":1},"properties":{"cost_model":{"additionalProperties":{"$ref":"#/components/schemas/CostModelMinimalObject"},"description":"A Cost Model associated with this Cost Model Version.","nullable":false},"id":{"description":"Unique identifier for the Cost Model Version.","type":"integer"},"version":{"description":"Version the Cost Model.","type":"integer"}},"required":["id","version"],"title":"CostModelVersionMinimalObject","type":"object"},"ImportLicenseParams":{"description":"Available parameters to create or update an Import License.","example":{"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"},"properties":{"approved_at":{"description":"The timestamp when the Import License was approved.","format":"date-time","nullable":true,"type":"string"},"extra":{"description":"Additional information related to the Import License.","nullable":true,"type":"object"},"last_updated_at":{"description":"The timestamp when the Import License was last updated.","format":"date-time","nullable":true,"type":"string"},"number":{"description":"The Import License number.","type":"string"},"registered_at":{"description":"The timestamp when the Import License was registered.","format":"date-time","nullable":true,"type":"string"},"status":{"description":"The current status of the Import License.","enum":["FOR_ANALYSIS","IN_ANALYSIS","IN_DEMANDED","REJECTED","DEFERRED","JUDICIALLY_DEFERRED","DEFERRED_LINKED_TO_DI","JUDICIALLY_DEFERRED_LINKED_TO_DI","DEFERRED_RESERVED","JUDICIALLY_DEFERRED_RESERVED","AUTHORIZED_BOARDING","EXPIRED","CLEARED","CANCELED"],"nullable":true,"type":"string"},"status_updated_at":{"description":"The timestamp when the status of the Import License was last updated.","format":"date-time","nullable":true,"type":"string"}},"title":"ImportLicenseParams","type":"object"},"NestedShipmentImportLicenseParams":{"description":"Available parameters to create or update a Shipment Import License.","example":{"comments":"Any 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"}},"properties":{"comments":{"description":"Additional comments or notes related to the Shipment Import License.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Shipment Import License.","type":"integer"},"import_license":{"$ref":"#/components/schemas/ImportLicenseParams"}},"title":"NestedShipmentImportLicenseParams","type":"object"},"CostModelMinimalObject":{"description":"This schema defines an 'Cost Model' data structure.","example":{"id":123,"name":"Cost Model"},"properties":{"id":{"description":"Unique identifier for the Cost Model.","type":"integer"},"name":{"description":"Name for the Cost Model.","type":"string"}},"required":["id","name"],"title":"CostModelMinimalObject","type":"object"},"ForeignTradeShipment":{"description":"This schema defines a 'Foreign Trade Shipment' data structure.","example":{"road_transport_shipment":null,"etd":"2023-10-29T00:00:00Z","received_in_warehouse_at":"2023-10-29T00:00:00Z","inserted_at":"2023-01-01T00:00:00Z","hawb_shipment_data":{"airline":{"callsign":"AMERICAN","hub_code":"DFW","iata_code":"AA","icao_code":"AAL","id":1,"name":"American Airlines"},"arrival_place_dta":"Warehouse B","ata":"2023-04-02T14:30:00Z","ata_dta":"2023-04-03T11:00:00Z","atd":"2023-04-01T10:15:00Z","atd_dta":"2023-04-03T09:00:00Z","departure_place_dta":"Airport A","di_number":"DI987654","dta_number":"DTA123456","eta":"2023-04-02T14:00:00Z","etd":"2023-04-01T10:00:00Z","extra":{},"flight":"AA123","hawb":"123-45678901","id":1,"loading_airport":{"city_iata_code":"SAO","iata_code":"GRU","icao_code":"SBGR","id":2736,"latitude":-22.816668,"longitude":-45.216667,"name":"Aeroporto Internacional Guarulhos","timezone":"America/Sao_Paulo"},"status":"In Transit","stopovers":1,"unloading_airport":{"city_iata_code":"SAO","iata_code":"GRU","icao_code":"SBGR","id":2736,"latitude":-22.816668,"longitude":-45.216667,"name":"Aeroporto Internacional Guarulhos","timezone":"America/Sao_Paulo"},"vehicle_plate_dta":"ABC1234"},"international_transport_legs":[{"arrival_place":"DEHAM","ata":"2024-07-05T21:00:00Z","atd":"2024-06-20T13:00:00Z","departure_place":"SGSIN","eta":"2024-07-05T20:00:00Z","etd":"2024-06-20T12:00:00Z","modal_type":"MARITIME","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":"VY7531"}],"parcel_shipments":[{"ata":null,"atd":"2023-05-15T10:15:00Z","courier":{"code":"COR","id":1,"name":"Correios"},"destination_address":"Av. B, 456, São Paulo, SP, Brasil","destination_country_code":"BR","eta":"2023-05-20T12:00:00Z","etd":"2023-05-15T10:00:00Z","id":1,"origin_address":"Rua A, 123, Rio de Janeiro, RJ, Brasil","origin_country_code":"BR","slug":"CourierWidget","tracking_number":"BR1234567890"}],"shipment_export_declarations":[{"comments":"","export_declaration":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","id":1,"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"},"id":1}],"type":"MARITIME_TRANSPORT","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","national_road_carrier":{"actor":{"cnae":"","contact_details":"Contact Details","description":"Description","document_type":"CNPJ","id":1,"internal_code":"123123","logo_url":null,"nickname":"Nickname","official_document":"11111111111111","official_name":"Actor","opening_date":"2023-01-01","roles":[{"access_group":{"slug":"access_group"},"role":"CARGO_OWNER"}],"trading_name":"Trading Name","verified":true},"business_unit":"Business Unit","id":1,"operation_handler":{"id":1,"role":"CARGO_OWNER"},"reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"},"quantity_pallets":100,"released_for_transport_at":"2023-10-29T00:00:00Z","road_transport_type":"LTL","route":{"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"}]}],"invoices":[{"currency":{"code":"USD","name":"US Dollar","symbol":"$"},"discount":"34.56","emitted_at":"2023-11-04T10:00:00Z","final_value":"1200.00","id":1,"incoterm":"CPT","items":[{"batch_number":"BATCH-6789","batch_validity_date":"2024-10-29T00:00:00Z","id":1,"order_item_line_reference":"1","order_reference_code":"ORC-123","product_description":"Product A","product_sku":"SKU-12345","production_date":"2023-10-29T00:00:00Z","quantity":"5","shipment_quantity":5,"total_amount":"61.70","total_gross_weight_kg":"80.00","unitary_amount":"12.34"}],"number":"INV-2023-001","total_amount":"1234.56","updated_at":"2023-11-04T14:30:00Z"}],"shipment_import_declarations":[{"comments":"","id":1,"import_declaration":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","id":1,"import_licenses":[{"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"}],"items":[{"brazilian_invoice_unit_value":"10","cubage_cubic_meters":null,"gross_weight_kg":null,"id":123,"net_weight_kg":"0.5","purchase_order_item":{"net_weight_kg":null,"order_value":null,"shipment_estimated_boarding_at":null,"supplier_confirmation_at":null,"shipment_boarding_lead_time":null,"order_currency":{"code":"USD","name":"US Dollar"},"line_number":1,"line_reference":"1.1","customs_release_lead_time":null,"order_unit_value":null,"shipment_estimated_arrival_at":null,"import_type_sap":null,"manufacturing_country":{"code":"BR","name":"Brazil"},"shipment_planned_boarding_at":null,"sap_by_factor":null,"order_modal_type_sap":null,"shipping_details_delivery_date":null,"shipment_equipment_type":null,"order_item_reference":null,"dispatching_country":{"code":"BR","name":"Brazil"},"factory_estimated_delivery_at":null,"delivery_note":null,"factory_delivery_lead_time":null,"adjusted_factory_delivery_lead_time":null,"assessment_sotd":null,"planning_request_shipping_at":null,"order_adjusted_modal_type":null,"order_request_number":null,"concession_act":null,"customs_estimated_release_at":null,"quotation_opening_date":null,"adjusted_customs_release_lead_time":null,"measurement_unit_sap":null,"shipment_transport_lead_time":null,"id":123,"order_requested_at":null,"delivery_note_issued_at":null,"gross_weight_kg":null,"purchase_country":{"code":"BR","name":"Brazil"},"supplier_ready_lead_time_days":null,"quantity":"20.0","invoice_issued_at":null,"shipment_planned_arrival_at":null,"product_description":"Descrição Produto","supplier_estimated_ready_at":null,"invoice_value":null,"product_mercosul_code":"8708.80.00","customs_register_lead_time":null,"adjusted_shipment_transport_lead_time":null,"planning_shipping_at":null,"balance":"10.0","order":{"id":2,"reference_code":"REF-2"},"invoice_number":null,"adjusted_customs_register_lead_time":null,"customs_estimated_register_at":null,"balance_shipped":"10.0","order_total_value":null,"shipment_containers_quantity":null,"supplier_sent_at":null,"supplier_ready_at":null,"factory_delivery_at":null,"factory_planned_delivery_at":null,"invoice_type":null,"adjusted_shipment_boarding_lead_time":null,"item_status":null,"product":{"code":"REF1234","description":"Descrição Produto","id":2,"mercosul_code":"8708.80.00","package_type":"BOTTLES"},"adjusted_supplier_ready_lead_time_days":null,"supplier_planned_ready_at":null,"supplier_calculated_ready_at":null,"cubage_cubic_meters":null},"quantity":"10","sales_order_item":null,"total_value":"100","unit_value":"10"}],"ce_mercante_number":null,"ata":"2023-10-29T00:00:00Z","empty_return_date":"2023-10-29T00:00:00Z","eta":"2023-10-29T00:00:00Z","automatic_tracking_enabled":true,"total_net_weight":"1.7","days_in_warehouse":2,"id":123,"ce_mercante_data":{"bl":null,"cargo_description":null,"cargo_manifests":[{"discharge_port_terminal":null,"discharge_port_unlocode":"BRSSZ","loading_port_terminal":null,"loading_port_unlocode":"BRRIO","manifest_number":"1234"}],"cargo_presence_at":null,"cargo_presence_history":[{"date":"2024-07-04T00:00:00Z","dta_number":null,"ra":"0403201","status":"ARMAZENADA","synced_at":"2024-07-05T10:00:00Z"}],"cargo_presence_in_primary_zone_at":null,"cargo_presence_in_secondary_zone_at":null,"cargo_status":null,"consignee_document":null,"consignee_extra_info":null,"container_seals":[{"container_code":"TGHU1234567","seal_code":"SF1234","secondary_seal_code":null}],"customs_place":null,"destination_port":{"country":{"code":"BR","iso3":"BRA","name":"Brazil"},"id":123,"latitude":-23.951,"longitude":-46.354,"name":"Santos","unlocode":"BRSSZ"},"di_number":null,"dta_number":null,"final_destination_arrival_at":null,"freight_basic_cost":null,"freight_currency":{"code":"USD","name":"US Dollar","symbol":"$"},"freight_payment_type":null,"freight_total_cost":null,"gross_weight_kg":null,"has_dta":false,"id":1,"issued_at":null,"last_updated_at":null,"manifest_arrival_at":null,"notes":null,"number":"123","origin_port":{"country":{"code":"BR","iso3":"BRA","name":"Brazil"},"id":123,"latitude":-23.951,"longitude":-46.354,"name":"Santos","unlocode":"BRSSZ"},"shipping_agency":{"cnae":"","contact_details":"Contact Details","description":"Description","document_type":"CNPJ","id":1,"internal_code":"123123","logo_url":null,"nickname":"Nickname","official_document":"11111111111111","official_name":"Actor","opening_date":"2023-01-01","roles":[{"access_group":{"slug":"access_group"},"role":"CARGO_OWNER"}],"trading_name":"Trading Name","verified":true},"status_response":"PENDING"},"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"}],"shipment_duimps":[{"comments":"","duimp":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","id":1,"inserted_at":"2023-11-04T09:30:00Z","last_updated_at":"2023-11-04T14:30:00Z","number":"21BR00000012345","registered_at":"2023-11-04T10:00:00Z","status":"ADVANCE_DELIVERY_AWAITING_CARGO_DELIVERY","status_response":"FOUND","version":1},"id":1}],"transportables":[{"cargo":null,"container":{"actual_return_empty_container_at":"2023-01-01T00:00:00Z","code":"MSDU5953962","cubic_meters":30.0,"demurrage_free_time_start_at":"2023-01-01T00:00:00Z","dispatch_number":"DISP12345","estimated_return_empty_container_at":"2023-01-01T00:00:00Z","events":[{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"CNXIS","status":"Empty to Shipper","transport":null,"voyage":"CNXISTRB"},{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"CNNGB","status":"Export received at CY","transport":null,"voyage":"CNNGBTRB"},{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"CNNGB","status":"Export Loaded on Vessel","transport":"9484455","voyage":"CNNGBUX333A"},{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"DOCAU","status":"Full Transshipment Discharged","transport":"9484455","voyage":"DOCAUUX338R"},{"datetime":"2023-01-01T00: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","is_stackable":true,"load_type":"GENERAL_CARGO","max_weight_kg":"100.123","observations":"observation example","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,"transport_document":"TDOC67890","type":"DRY"},"id":123,"type":"CONTAINER"}],"international_freight":{"booking_discharge_airport":{"city_iata_code":"SAO","iata_code":"GRU","icao_code":"SBGR","id":2736,"latitude":-22.816668,"longitude":-45.216667,"name":"Aeroporto Internacional Guarulhos","timezone":"America/Sao_Paulo"},"booking_discharge_port":{"country":{"code":"BR","iso3":"BRA","name":"Brazil"},"id":123,"latitude":-23.951,"longitude":-46.354,"name":"Santos","unlocode":"BRSSZ"},"booking_eta":"2023-10-29T00:00:00Z","booking_etd":"2023-10-29T00:00:00Z","booking_loading_airport":{"city_iata_code":"SAO","iata_code":"GRU","icao_code":"SBGR","id":2736,"latitude":-22.816668,"longitude":-45.216667,"name":"Aeroporto Internacional Guarulhos","timezone":"America/Sao_Paulo"},"booking_loading_port":{"country":{"code":"BR","iso3":"BRA","name":"Brazil"},"id":123,"latitude":-23.951,"longitude":-46.354,"name":"Santos","unlocode":"BRSSZ"},"cargo_attributes":["REEFER"],"currency":{"code":"USD","name":"US Dollar","symbol":"$"},"freight_cost_collect":"1250.00","freight_cost_prepaid":"1250.00","freight_cost_road":null,"freight_cost_total":"2500.00","freight_forwarder":"ABC Shipping","id":1,"planned_boarding_date":"2023-10-29T00:00:00Z","port_terminal":{"id":123,"name":"Santos Brasil"},"quotation_number":"Q123456","sealine":{"id":1,"nickname":"Maersk","scac":"MAEU"},"type":"PREPAID","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":"123A"},"total_gross_weight":"2.0","demurrage":{"daily_rate_usd":"10.5","free_time":2,"id":1},"days_left_in_warehouse":1,"air_transport_shipment":null,"status_response":"FOUND","atd":"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,"nickname":"Maersk","scac":"MAEU"},"tracking_discharge_port":"BRRIG","tracking_key":"BILL_OF_LADING","tracking_loading_port":"CNNGB","tracking_number":null,"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"},"warehouse_free_time_days":1,"route":{"active":true,"id":123,"name":"Route A","points":[{"id":123,"position":1,"route_type":"LOADING"}]},"delivered_at":"2023-10-29T00:00:00Z","last_tracking_at":"2023-10-29T00:00:00Z","departed_from_warehouse_at":"2023-10-29T00:00:00Z","cubage_cubic_meters":"1.5"},"properties":{"road_transport_shipment":{"additionalProperties":{"$ref":"#/components/schemas/RoadTransportShipment"},"description":"Details of Road Transport Shipment if type is 'road_transport'.","nullable":true},"etd":{"description":"ETD (Estimated Time of Departure) for the Shipment.","format":"date-time","nullable":true,"type":"string"},"received_in_warehouse_at":{"description":"Date and time when the Shipment was received in the warehouse.","format":"date-time","nullable":true,"type":"string"},"inserted_at":{"description":"Date and time when the Shipment information was inserted.","format":"date-time","type":"string"},"hawb_shipment_data":{"additionalProperties":{"$ref":"#/components/schemas/HawbShipmentData"},"description":"Details of HAWB Shipment Data associated with this Shipment.","nullable":true},"international_transport_legs":{"description":"A collection of legs related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/InternationalTransportLeg"},"description":"Details of the legs associated with this Shipment."},"type":"array"},"parcel_shipments":{"description":"A collection of Parcel Shipments related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/ParcelShipment"},"description":"Details of the Parcel Shipment associated with this Shipment."},"type":"array"},"shipment_export_declarations":{"description":"A collection of Export Declarations related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/ShipmentExportDeclaration"},"description":"Details of the Export Declarations associated with this Shipment."},"type":"array"},"type":{"description":"Type of the Shipment.","enum":["AIR_TRANSPORT","MARITIME_TRANSPORT","ROAD_TRANSPORT"],"type":"string"},"national_road_transports":{"description":"A collection of National Road Transport related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NationalRoadTransport"},"description":"Details of the National Road Transport associated with this Shipment."},"type":"array"},"invoices":{"description":"A collection of Invoices related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/Invoice"},"description":"Details of the Invoice associated with this Shipment."},"type":"array"},"shipment_import_declarations":{"description":"A collection of Import Declarations related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/ShipmentImportDeclaration"},"description":"Details of the Import Declarations associated with this Shipment."},"type":"array"},"items":{"description":"A collection of Items related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/ForeignTradeItemShipment"},"description":"Details of the Item associated with this Shipment."},"type":"array"},"ce_mercante_number":{"description":"CE Mercante Number associated with the Shipment.","type":"string"},"ata":{"description":"ATA (Actual Time of Arrival) for the Shipment.","format":"date-time","nullable":true,"type":"string"},"empty_return_date":{"description":"Date and time the container returned empty.","format":"date-time","nullable":true,"type":"string"},"eta":{"description":"ETA (Estimated Time of Arrival) for the Shipment.","format":"date-time","nullable":true,"type":"string"},"automatic_tracking_enabled":{"description":"Boolean flag indicating if Automatic Tracking is enabled.","type":"boolean"},"total_net_weight":{"description":"Total net weight associated with the Shipment.","format":"decimal","nullable":true,"type":"string"},"days_in_warehouse":{"description":"Number of days the Shipment has spent in the warehouse.","type":"integer"},"id":{"description":"Unique identifier for the Foreign Trade Shipment.","type":"integer"},"ce_mercante_data":{"additionalProperties":{"$ref":"#/components/schemas/CeMercanteData"},"description":"Details of CE Mercante associated with this Shipment.","nullable":true},"shipment_import_licenses":{"description":"A collection of Import Licenses related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/ShipmentImportLicense"},"description":"Details of the Import Licenses associated with this Shipment."},"type":"array"},"shipment_duimps":{"description":"A collection of DUIMP related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/ShipmentDuimp"},"description":"Details of the DUIMP associated with this Shipment."},"type":"array"},"transportables":{"description":"A collection of Transportable related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/Transportable"},"description":"Details of the Transportable associated with this Shipment."},"type":"array"},"international_freight":{"additionalProperties":{"$ref":"#/components/schemas/InternationalFreight"},"description":"Details of the International Freight associated with this Shipment."},"total_gross_weight":{"description":"Total gross weight associated with the Shipment.","format":"decimal","nullable":true,"type":"string"},"demurrage":{"additionalProperties":{"$ref":"#/components/schemas/Demurrage"},"description":"Details of demurrage associated with this Shipment.","nullable":true},"days_left_in_warehouse":{"description":"Number of days left for the Shipment in the warehouse.","type":"integer"},"air_transport_shipment":{"additionalProperties":{"$ref":"#/components/schemas/AirTransportShipment"},"description":"Details of Air Transport Shipment if type is 'air_transport'.","nullable":true},"status_response":{"default":"PENDING","description":"Automatic Shipment Tracking status response.","enum":["PENDING","NOT_FOUND","FOUND","INVALID"],"type":"string"},"atd":{"description":"ATD (Actual Time of Departure) for the Shipment.","format":"date-time","nullable":true,"type":"string"},"last_updated_at":{"description":"Automatic Shipment Tracking last updated date and time.","format":"date-time","nullable":true,"type":"string"},"maritime_transport_shipment":{"additionalProperties":{"$ref":"#/components/schemas/MaritimeTransportShipment"},"description":"Details of Maritime Transport Shipment if type is 'maritime_transport'.","nullable":true},"warehouse_free_time_days":{"description":"Number of days of warehouse free time.","type":"integer"},"ce_mercante_authorization_status":{"description":"CE Mercante Authorization Status associated with the Shipment.","enum":["AUTHORIZED","FORBIDDEN","NOT_AUTHORIZED","PENDING"],"type":"string"},"route":{"additionalProperties":{"$ref":"#/components/schemas/Route"},"description":"Information about the transportation routes related to this Shipment.","nullable":true},"delivered_at":{"description":"Date and time when the Shipment was delivered.","format":"date-time","nullable":true,"type":"string"},"last_tracking_at":{"description":"Date and time of the last Tracking event for the Shipment.","format":"date-time","nullable":true,"type":"string"},"departed_from_warehouse_at":{"description":"Date and time when the Shipment departed from the warehouse.","format":"date-time","nullable":true,"type":"string"},"cubage_cubic_meters":{"description":"Cubage in cubic meters associated with the Shipment.","format":"decimal","nullable":true,"type":"string"}},"required":["id","inserted_at","status_response","automatic_tracking_enabled","warehouse_free_time_days","type","days_in_warehouse","days_left_in_warehouse"],"title":"ForeignTradeShipment","type":"object"},"RoadTransportTripPhase":{"description":"This schema defines a 'Road Transport Trip Phase' data structure.","example":{"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"}},"properties":{"departure_at":{"description":"The timestamp when the Phase started.","format":"date-time","nullable":true,"type":"string"},"estimated_realized_at":{"description":"The estimated timestamp when the Phase was realized.","format":"date-time","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Road Transport Trip Phase.","type":"integer"},"realized_at":{"description":"The timestamp when the Phase was realized.","format":"date-time","nullable":true,"type":"string"},"route_point":{"additionalProperties":{"$ref":"#/components/schemas/RoutePoint"},"description":"Information about the route point associated with this Phase."}},"required":["id","route_point"],"title":"RoadTransportTripPhase","type":"object"},"RouteResponse":{"description":"Schema representing the response for a single route. Contains route data.","properties":{"data":{"$ref":"#/components/schemas/Route"}},"title":"RouteResponse","type":"object"},"Actor":{"description":"This schema defines an 'Actor' data structure.","example":{"cnae":"","contact_details":"Contact Details","description":"Description","document_type":"CNPJ","id":1,"internal_code":"123123","logo_url":null,"nickname":"Nickname","official_document":"11111111111111","official_name":"Actor","opening_date":"2023-01-01","roles":[{"access_group":{"slug":"access_group"},"role":"CARGO_OWNER"}],"trading_name":"Trading Name","verified":true},"properties":{"cnae":{"description":"The CNAE (National Classification of Economic Activities) code associated with the Actor.","nullable":true,"type":"string"},"contact_details":{"description":"The Actor's Contact Details.","nullable":true,"type":"string"},"description":{"description":"The Actor's Description.","nullable":true,"type":"string"},"document_type":{"description":"The Type of Official Document.","enum":["CNPJ","CPF","TIN","INTERNAL_CODE"],"nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Actor.","type":"integer"},"internal_code":{"description":"The Actor's Internal Code.","nullable":true,"type":"string"},"nickname":{"description":"The Actor's Nickname.","type":"string"},"official_document":{"description":"The Actor's Official Document.","nullable":true,"type":"string"},"official_name":{"description":"The Actor's Official Name.","type":"string"},"opening_date":{"description":"The date when the Actor was established.","format":"date","nullable":true,"type":"string"},"roles":{"deprecated":true,"description":"An array of roles that the Actor can have.","items":{"properties":{"access_group":{"description":"The access group associated to that role","properties":{"slug":{"description":"The slug of the access group","type":"string"}},"type":"object"},"role":{"description":"The role","enum":["ACQUIRER","AGENT","BANK","BONDED_TERMINAL","CARGO_OWNER","CONTAINER_DEPOT","CUSTOMER","CUSTOMS_BROKER","CUSTOMS_TERMINAL","EXPORTER","FUNDER","FREIGHT_FORWARDER","IMPORTER","INTEGRATOR","INTERNATIONAL_ROAD_CARRIER","MANUFACTURER","NATIONAL_ROAD_CARRIER","SUPPLIER","TRADING","WAREHOUSE"],"type":"string"}},"type":"object"},"type":"array"},"trading_name":{"description":"The Actor's Trading Name.","nullable":true,"type":"string"},"verified":{"description":"A boolean value indicating whether the Actor has been Verified.","type":"boolean"}},"required":["id","official_name","nickname","verified"],"title":"Actor","type":"object"},"PartnershipResponse":{"description":"API response for a Partnership","example":{"data":{"contact_details":"email: john@company.com","description":"Example partnership description","id":3275,"internal_code":"EXAMPLE-001","nickname":"Example Company","partner":{"cnae":null,"document_type":null,"id":11871,"nickname":"Example Company","official_document":null,"official_name":"Example Company","opening_date":null,"roles":[],"trading_name":"Example Company","verified":false},"roles":[{"access_group":null,"role":"SUPPLIER"}]}},"properties":{"data":{"properties":{"contact_details":{"description":"Partnership contact details","nullable":true,"type":"string"},"description":{"description":"Partnership description","nullable":true,"type":"string"},"id":{"description":"Partnership ID","type":"integer"},"internal_code":{"description":"Partnership internal code","nullable":true,"type":"string"},"nickname":{"description":"Partnership nickname","nullable":true,"type":"string"},"partner":{"properties":{"cnae":{"description":"Partner Actor CNAE code","nullable":true,"type":"string"},"document_type":{"description":"Partner Actor document type","nullable":true,"type":"string"},"id":{"description":"Partner Actor ID","type":"integer"},"nickname":{"description":"Partner Actor nickname","type":"string"},"official_document":{"description":"Partner Actor official document","nullable":true,"type":"string"},"official_name":{"description":"Partner Actor official name","type":"string"},"opening_date":{"description":"Partner Actor opening date","format":"date","nullable":true,"type":"string"},"roles":{"deprecated":true,"description":"List of Actor roles","items":{"type":"string"},"type":"array"},"trading_name":{"description":"Partner Actor trading name","nullable":true,"type":"string"},"verified":{"description":"Whether the Actor is verified","type":"boolean"}},"type":"object"},"roles":{"items":{"properties":{"access_group":{"nullable":true,"properties":{"slug":{"description":"Access group identifier","type":"string"}},"type":"object"},"role":{"description":"Actor role/function","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"title":"PartnershipResponse","type":"object"},"NestedCreateAirTransportShipmentParams":{"description":"Available nested parameters to create an Air Transport Shipment.","example":{"airline_id":1,"awb":"123-45678901","destination_airport_id":1,"hawb":"HAWB-123456","origin_airport_id":2736,"type":"ENVIROTAINER"},"properties":{"airline_id":{"description":"Unique identifier for the Airline.","nullable":true,"type":"integer"},"awb":{"description":"Air Waybill (AWB) number associated with the Shipment.","nullable":true,"type":"string"},"destination_airport_id":{"description":"Unique identifier for the Destination Airport.","nullable":true,"type":"integer"},"hawb":{"description":"House Air Waybill (HAWB) number associated with the Shipment.","nullable":true,"type":"string"},"origin_airport_id":{"description":"Unique identifier for the Origin Airport.","nullable":true,"type":"integer"},"type":{"description":"Type of Shipment.","enum":["ENVIROTAINER","PALLET","LOOSE_CARGO"],"nullable":true,"type":"string"}},"title":"NestedCreateAirTransportShipmentParams","type":"object"},"Sealine":{"description":"This schema defines a 'Sealine' data structure.","example":{"id":1,"nickname":"Maersk","scac":"MAEU"},"properties":{"id":{"description":"Unique identifier for the Sealine.","type":"integer"},"nickname":{"description":"A commonly used nickname or abbreviation for the Sealine.","type":"string"},"scac":{"description":"The Standard Carrier Alpha Code (SCAC) for the Sealine.","type":"string"}},"required":["id","nickname","scac"],"title":"Sealine","type":"object"},"CostModelVersionResponse":{"description":"Schema representing the response for a single cost model version. Contains cost model version data.","properties":{"data":{"$ref":"#/components/schemas/CostModelVersionFullObject"}},"title":"CostModelVersionResponse","type":"object"},"ImportLicense":{"description":"This schema defines a 'Import License' data structure.","example":{"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"},"properties":{"approved_at":{"description":"The timestamp when the Import License was approved.","format":"date-time","nullable":true,"type":"string"},"extra":{"description":"Additional information related to the Import License.","nullable":true,"type":"object"},"id":{"description":"Unique identifier for the Import License.","type":"integer"},"import_declaration":{"description":"The Import Declaration associated with the Import License.","nullable":true,"properties":{"number":{"description":"The Import Declaration number.","type":"string"}},"type":"object"},"inserted_at":{"description":"The timestamp when the Import License was inserted.","format":"date-time","type":"string"},"last_updated_at":{"description":"The timestamp when the Import License was last updated.","format":"date-time","nullable":true,"type":"string"},"number":{"description":"The Import License number.","type":"string"},"registered_at":{"description":"The timestamp when the Import License was registered.","format":"date-time","nullable":true,"type":"string"},"status":{"description":"The current status of the Import License.","enum":["FOR_ANALYSIS","IN_ANALYSIS","IN_DEMANDED","REJECTED","DEFERRED","JUDICIALLY_DEFERRED","DEFERRED_LINKED_TO_DI","JUDICIALLY_DEFERRED_LINKED_TO_DI","DEFERRED_RESERVED","JUDICIALLY_DEFERRED_RESERVED","AUTHORIZED_BOARDING","EXPIRED","CLEARED","CANCELED"],"nullable":true,"type":"string"},"status_response":{"description":"The response status for the Import License.","enum":["PENDING","NOT_FOUND","FOUND","INVALID"],"type":"string"},"status_updated_at":{"description":"The timestamp when the status of the Import License was last updated.","format":"date-time","nullable":true,"type":"string"}},"required":["id","number","status_response","inserted_at"],"title":"ImportLicense","type":"object"},"NestedCreateForeignTradeItemShipmentParams":{"description":"Available parameters to create a Foreign Trade Item Shipment.","example":{"brazilian_invoice_unit_value":"10","cubage_cubic_meters":null,"gross_weight_kg":null,"line_reference":null,"net_weight_kg":"0.5","order_reference_code":null,"purchase_order_item_id":1,"quantity":"10","sales_order_item_id":null,"unit_value":"10"},"properties":{"brazilian_invoice_unit_value":{"description":"The brazilian invoice unit value of this item in this Shipment.","format":"number","nullable":true,"type":"string"},"cubage_cubic_meters":{"description":"Cubage in cubic meters of this item in this Shipment.","format":"number","nullable":true,"type":"string"},"gross_weight_kg":{"description":"The gross weight in kilograms of this item in this Shipment.","format":"number","nullable":true,"type":"string"},"line_reference":{"description":"The Line Reference of the Order Item.","nullable":true,"type":"string"},"net_weight_kg":{"description":"The net weight of this item in this Shipment.","format":"number","nullable":true,"type":"string"},"order_reference_code":{"description":"The Reference Code of the associated Order.","nullable":true,"type":"string"},"purchase_order_item_id":{"description":"Unique identifier for the POI.","nullable":true,"type":"integer"},"quantity":{"description":"The number of products in this Shipment that originated from the associated Order.","format":"number","nullable":true,"type":"string"},"sales_order_item_id":{"description":"Unique identifier for the SOI.","nullable":true,"type":"integer"},"unit_value":{"description":"The unit value of this item in this Shipment.","format":"number","nullable":true,"type":"string"}},"title":"NestedCreateForeignTradeItemShipmentParams","type":"object"},"UpsertOrderParams":{"description":"List of parameters to Upsert (Update/Create) a Order.","example":{"params":[{"external_reference_code":"ECT1","handler":{"acquirer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"agent":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"bank":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"bonded_terminal":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"cargo_owner":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"container_depot":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customs_broker":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customs_terminal":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"exporter":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"freight_forwarder":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"funder":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"importer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"integrator":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"international_road_carrier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"manufacturer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"national_road_carrier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"supplier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"trading":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"warehouse":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}]},"handlers":[],"observations":"Observations...","purchase_order":{"items":[{"net_weight_kg":null,"order_value":null,"shipment_estimated_boarding_at":null,"supplier_confirmation_at":null,"shipment_boarding_lead_time":null,"manufacturing_country_code":"BR","line_number":1,"line_reference":"1.1","customs_release_lead_time":null,"order_unit_value":null,"shipment_estimated_arrival_at":null,"import_type_sap":null,"shipment_planned_boarding_at":null,"sap_by_factor":null,"order_modal_type_sap":null,"shipping_details_delivery_date":null,"shipment_equipment_type":null,"order_item_reference":null,"factory_estimated_delivery_at":null,"delivery_note":null,"factory_delivery_lead_time":null,"adjusted_factory_delivery_lead_time":null,"product_code":"PRD-123","assessment_sotd":null,"planning_request_shipping_at":null,"order_adjusted_modal_type":null,"order_request_number":null,"concession_act":null,"customs_estimated_release_at":null,"purchase_country_code":"BR","quotation_opening_date":null,"adjusted_customs_release_lead_time":null,"measurement_unit_sap":null,"shipment_transport_lead_time":null,"id":1,"order_requested_at":null,"delivery_note_issued_at":null,"gross_weight_kg":null,"supplier_ready_lead_time_days":null,"quantity":"20.0","invoice_issued_at":null,"shipment_planned_arrival_at":null,"supplier_estimated_ready_at":null,"order_currency_code":"USD","invoice_value":null,"customs_register_lead_time":null,"adjusted_shipment_transport_lead_time":null,"planning_shipping_at":null,"invoice_number":null,"adjusted_customs_register_lead_time":null,"customs_estimated_register_at":null,"shipment_containers_quantity":null,"product_id":1,"supplier_sent_at":null,"supplier_ready_at":null,"dispatching_country_code":"BR","factory_delivery_at":null,"factory_planned_delivery_at":null,"item_foreign_operators":[],"invoice_type":null,"adjusted_shipment_boarding_lead_time":null,"item_status":null,"adjusted_supplier_ready_lead_time_days":null,"supplier_planned_ready_at":null,"supplier_calculated_ready_at":null,"cubage_cubic_meters":null}],"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":"YOUR_REFERENCE_CODE"}]},"properties":{"params":{"items":{"description":"Available parameters to upsert a Order.","properties":{"external_reference_code":{"description":"An external reference code associated with the Order.","nullable":true,"type":"string"},"handler":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpsertHandlersByRoleParams"},"description":"Handlers responsible for managing this Process by Role."},"handlers":{"deprecated":true,"description":"An array of Handlers responsible for managing this Order.","items":{"$ref":"#/components/schemas/NestedUpdateHandlerParams"},"type":"array"},"observations":{"description":"Textual field for recording observations or comments related to the PO.","nullable":true,"type":"string"},"purchase_order":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdatePurchaseOrderParams"},"description":"A Purchase Order (PO) associated with this Order."},"reference_code":{"description":"A reference code of the Order.\nThis is the key used to check whether the order should be updated or created.\n","nullable":false,"type":"string"},"sales_order":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateSalesOrderParams"},"description":"A Sales Order (SO) associated with this Order."},"subsidiary_id":{"description":"Unique identifier for the Subsidiary.","nullable":true,"type":"integer"}},"required":["reference_code"],"type":"object"},"type":"array"}},"title":"UpsertOrderParams","type":"object"},"NestedShipmentDuimpParams":{"description":"Available parameters to create or update a Shipment DUIMP.","example":{"comments":"Any comments","duimp":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","last_updated_at":"2023-11-04T14:30:00Z","number":"21BR00000012345","registered_at":"2023-11-04T10:00:00Z","status":"ADVANCE_DELIVERY_AWAITING_CARGO_DELIVERY","version":1},"id":1},"properties":{"comments":{"description":"Additional comments or notes related to the Shipment DUIMP.","nullable":true,"type":"string"},"duimp":{"$ref":"#/components/schemas/DuimpParams"},"id":{"description":"Unique identifier for the Shipment DUIMP.","type":"integer"}},"title":"NestedShipmentDuimpParams","type":"object"},"RoutePoint":{"description":"This schema defines a 'Route Point' data structure.","example":{"id":123,"position":1,"route_type":"LOADING"},"properties":{"id":{"description":"Unique identifier for the Route Point.","type":"integer"},"position":{"description":"The position of the Route Point in the Route sequence.","type":"integer"},"route_type":{"description":"The type of the Route Point.","enum":["LOADING","UNLOADING","RETURN_EMPTY_CONTAINER","WITHDRAWAL_EMPTY_CONTAINER","LOADING_EMPTY_CONTAINER","UNLOADING_EMPTY_CONTAINER","LOADING_FULL_CONTAINER","UNLOADING_FULL_CONTAINER","INVOICE_EXCHANGE","AVAILABILITY_EMPTY_CONTAINER","ARRIVAL_AT_THE_BORDER"],"type":"string"}},"required":["id","route_type","position"],"title":"RoutePoint","type":"object"},"CreateOrderParams":{"description":"Available parameters to create an Order.","example":{"params":{"external_reference_code":"ECT1","handler":{"acquirer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"agent":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"bank":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"bonded_terminal":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"cargo_owner":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"container_depot":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customs_broker":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customs_terminal":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"exporter":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"freight_forwarder":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"funder":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"importer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"integrator":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"international_road_carrier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"manufacturer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"national_road_carrier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"supplier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"trading":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"warehouse":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}]},"handlers":[],"observations":"Observations...","purchase_order":{"items":[{"net_weight_kg":null,"order_value":null,"shipment_estimated_boarding_at":null,"supplier_confirmation_at":null,"shipment_boarding_lead_time":null,"manufacturing_country_code":"BR","line_number":1,"line_reference":"1.1","customs_release_lead_time":null,"order_unit_value":null,"shipment_estimated_arrival_at":null,"import_type_sap":null,"shipment_planned_boarding_at":null,"sap_by_factor":null,"order_modal_type_sap":null,"shipping_details_delivery_date":null,"shipment_equipment_type":null,"order_item_reference":null,"factory_estimated_delivery_at":null,"delivery_note":null,"factory_delivery_lead_time":null,"adjusted_factory_delivery_lead_time":null,"product_code":"PRD-123","assessment_sotd":null,"planning_request_shipping_at":null,"order_adjusted_modal_type":null,"order_request_number":null,"concession_act":null,"customs_estimated_release_at":null,"purchase_country_code":"BR","quotation_opening_date":null,"adjusted_customs_release_lead_time":null,"measurement_unit_sap":null,"shipment_transport_lead_time":null,"order_requested_at":null,"delivery_note_issued_at":null,"gross_weight_kg":null,"supplier_ready_lead_time_days":null,"quantity":"20.0","invoice_issued_at":null,"shipment_planned_arrival_at":null,"supplier_estimated_ready_at":null,"order_currency_code":"USD","invoice_value":null,"customs_register_lead_time":null,"adjusted_shipment_transport_lead_time":null,"planning_shipping_at":null,"invoice_number":null,"adjusted_customs_register_lead_time":null,"customs_estimated_register_at":null,"shipment_containers_quantity":null,"product_id":1,"supplier_sent_at":null,"supplier_ready_at":null,"dispatching_country_code":"BR","factory_delivery_at":null,"factory_planned_delivery_at":null,"item_foreign_operators":[],"invoice_type":null,"adjusted_shipment_boarding_lead_time":null,"item_status":null,"adjusted_supplier_ready_lead_time_days":null,"supplier_planned_ready_at":null,"supplier_calculated_ready_at":null,"cubage_cubic_meters":null}],"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"}},"properties":{"params":{"properties":{"external_reference_code":{"description":"An external reference code associated with the Order.","nullable":true,"type":"string"},"handler":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpsertHandlersByRoleParams"},"description":"Handlers responsible for managing this Process by Role."},"handlers":{"deprecated":true,"description":"An array of Handlers responsible for managing this Order.","items":{"$ref":"#/components/schemas/NestedCreateHandlerParams"},"type":"array"},"observations":{"description":"Textual field for recording observations or comments related to the PO.","nullable":true,"type":"string"},"purchase_order":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreatePurchaseOrderParams"},"description":"A Purchase Order (PO) associated with this Order."},"reference_code":{"description":"A reference code associated with the Order.","nullable":true,"type":"string"},"sales_order":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateSalesOrderParams"},"description":"A Sales Order (SO) associated with this Order."},"subsidiary_id":{"description":"Unique identifier for the Subsidiary.","nullable":true,"type":"integer"}},"type":"object"}},"title":"CreateOrderParams","type":"object"},"CeMercanteDataCargoPresenceHistory":{"description":"This schema defines a 'CeMercanteDataCargoPresenceHistory' data structure.","example":{"date":"2024-07-04T00:00:00Z","dta_number":null,"ra":"0403201","status":"ARMAZENADA","synced_at":"2024-07-05T10:00:00Z"},"properties":{"date":{"description":"The official date of this status change (dataSituacaoCarga).","format":"date-time","type":"string"},"dta_number":{"description":"The DTA number, if present at the time of this entry.","nullable":true,"type":"string"},"ra":{"description":"The customs storage location (RA) at the time of this entry.","type":"string"},"status":{"description":"The cargo status (situacaoCarga) at the time of this entry.","type":"string"},"synced_at":{"description":"The timestamp when Flowls captured this entry.","format":"date-time","type":"string"}},"title":"CeMercanteDataCargoPresenceHistory","type":"object"},"OrderResponses":{"description":"An array containing details of multiple orders.","properties":{"data":{"items":{"$ref":"#/components/schemas/Order"},"type":"array"}},"title":"OrderResponses","type":"object"},"ShipmentImportLicense":{"description":"This schema defines a 'Shipment Import License' data structure.","example":{"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"},"properties":{"comments":{"description":"Additional comments or notes related to the Shipment Import License.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Shipment Import License.","type":"integer"},"import_license":{"additionalProperties":{"$ref":"#/components/schemas/ImportLicense"},"description":"The Import License associated with this Shipment Import License.","nullable":true},"status":{"description":"The status of the Shipment Import License.","enum":["AUTHORIZED","FORBIDDEN","NOT_AUTHORIZED","PENDING"],"type":"string"}},"required":["id","status"],"title":"ShipmentImportLicense","type":"object"},"Container":{"description":"This schema defines a 'Container' data structure.","example":{"actual_return_empty_container_at":"2023-01-01T00:00:00Z","code":"MSDU5953962","cubic_meters":30.0,"demurrage_free_time_start_at":"2023-01-01T00:00:00Z","dispatch_number":"DISP12345","estimated_return_empty_container_at":"2023-01-01T00:00:00Z","events":[{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"CNXIS","status":"Empty to Shipper","transport":null,"voyage":"CNXISTRB"},{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"CNNGB","status":"Export received at CY","transport":null,"voyage":"CNNGBTRB"},{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"CNNGB","status":"Export Loaded on Vessel","transport":"9484455","voyage":"CNNGBUX333A"},{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"DOCAU","status":"Full Transshipment Discharged","transport":"9484455","voyage":"DOCAUUX338R"},{"datetime":"2023-01-01T00: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","is_stackable":true,"load_type":"GENERAL_CARGO","max_weight_kg":"100.123","observations":"observation example","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,"transport_document":"TDOC67890","type":"DRY"},"properties":{"actual_return_empty_container_at":{"description":"Actual date and time of the Container's empty return.","format":"date-time","nullable":true,"type":"string"},"code":{"description":"A code associated with the Container.","type":"string"},"cubic_meters":{"description":"The cubic meter the Container.","format":"number","type":"string"},"demurrage_free_time_start_at":{"description":"The starting point to count the container's Free Time before demurrage costs incur.","format":"date-time","nullable":true,"type":"string"},"dispatch_number":{"description":"The Dispatch number.","nullable":true,"type":"string"},"estimated_return_empty_container_at":{"description":"Estimated date and time for the Container's expected empty return.","format":"date-time","nullable":true,"type":"string"},"events":{"description":"List of events related to the Container.","items":{"$ref":"#/components/schemas/ContainerEvent"},"nullable":true,"type":"array"},"gross_weight_kg":{"description":"Gross weight of the Container in kilograms.","format":"decimal","nullable":true,"type":"string"},"hidden":{"default":false,"description":"Flag to determine whether the Container should be hidden.","type":"boolean"},"id":{"description":"Unique identifier for the Container.","type":"integer"},"invoice_number":{"description":"Invoice number associated with the Container.","nullable":true,"type":"string"},"is_stackable":{"description":"If is stackable Container.","format":"boolean","type":"string"},"load_type":{"description":"Type of Cargo the Container is designed.","enum":["GENERAL_CARGO","FOOD","PHARMACEUTICALS","WEAPONS","BULK"],"nullable":true,"type":"string"},"max_weight_kg":{"description":"Maximum weight capacity of the Container in kilograms.","format":"decimal","nullable":true,"type":"string"},"observations":{"description":"Container observations.","nullable":true,"type":"string"},"seal_code":{"description":"Code associated with Container Seals.","nullable":true,"type":"string"},"secondary_seal_code":{"description":"Secondary code for Container Seals.","nullable":true,"type":"string"},"size_foot_type":{"description":"Size of the Container in foot.","enum":["STANDARD_10","STANDARD_20","STANDARD_30","STANDARD_40","SPECIAL_20","SPECIAL_30","SPECIAL_40","SPECIAL_45","REDUCED_20","REDUCED_30","REDUCED_40","HC_20","HC_40","HC_45","SHC_20","SHC_40","SHC_45","PALLET_WIDE_40","PALLET_WIDE_45"],"nullable":true,"type":"string"},"tare_weight_kg":{"description":"Tare weight of the Container in kilograms.","format":"decimal","nullable":true,"type":"string"},"tracking_api":{"description":"Flag to determine if Container tracking is available through an API.","type":"boolean"},"tracking_manual":{"default":true,"description":"Flag to determine whether the Container was created or edited manually.","type":"boolean"},"transport_document":{"description":"The Transport Document.","nullable":true,"type":"string"},"type":{"description":"Type of the container.","enum":["BULK","DOUBLE_DOOR","DRY","FLAT_RACK","HARD_TOP","HIGH_CUBE","INSULATED","NON_OPERATING_REEFER","OPEN_TOP","PALLET_WIDE","PLATFORM","REEFER","SIDE_DOOR","SPECIAL","STANDARD","SWAP_BODY","TANK","VENTILATED"],"nullable":true,"type":"string"}},"required":["id","code","tracking_api","tracking_manual"],"title":"Container","type":"object"},"ProductResponse":{"description":"Schema representing the response for a single product. Contains product data.","properties":{"data":{"$ref":"#/components/schemas/Product"}},"title":"ProductResponse","type":"object"},"ShipmentImportDeclaration":{"description":"This schema defines a 'Shipment Import Declaration' data structure.","example":{"comments":"","id":1,"import_declaration":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","id":1,"import_licenses":[{"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"},"properties":{"comments":{"description":"Additional comments or notes related to the Shipment Import Declaration.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Shipment Import Declaration.","type":"integer"},"import_declaration":{"additionalProperties":{"$ref":"#/components/schemas/ImportDeclaration"},"description":"The Import Declaration associated with this Shipment Import Declaration.","nullable":true},"status":{"description":"The status of the Shipment Import Declaration.","enum":["AUTHORIZED","FORBIDDEN","NOT_AUTHORIZED","PENDING"],"type":"string"}},"required":["id","status"],"title":"ShipmentImportDeclaration","type":"object"},"NestedCreateParcelShipmentParams":{"description":"Parameters to create a Parcel Shipment.","example":{"ata":null,"atd":"2023-05-15T10:15:00Z","courier_id":1,"destination_address":"Av. B, 456, São Paulo, SP, Brasil","destination_country_code":"BR","eta":"2023-05-20T12:00:00Z","etd":"2023-05-15T10:00:00Z","origin_address":"Rua A, 123, Rio de Janeiro, RJ, Brasil","origin_country_code":"BR","slug":"CourierWidget","tracking_number":"BR1234567890"},"properties":{"ata":{"description":"ATA (Actual Time of Arrival).","format":"date-time","type":"string"},"atd":{"description":"ATD (Actual Time of Departure).","format":"date-time","nullable":true,"type":"string"},"courier_id":{"description":"ID of the courier handling the shipment.","nullable":true,"type":"integer"},"destination_address":{"description":"Destination address for the Parcel Shipment.","nullable":true,"type":"string"},"destination_country_code":{"description":"Country code of the destination.","nullable":true,"type":"string"},"eta":{"description":"ETA (Estimated Time of Arrival).","format":"date-time","nullable":true,"type":"string"},"etd":{"description":"ETD (Estimated Time of Departure).","format":"date-time","nullable":true,"type":"string"},"origin_address":{"description":"Origin address for the Parcel Shipment.","nullable":true,"type":"string"},"origin_country_code":{"description":"Country code of the origin.","nullable":true,"type":"string"},"slug":{"description":"Courier slug for the Parcel Shipment.","type":"string"},"tracking_number":{"description":"Tracking number for the Parcel Shipment.","type":"string"}},"required":["tracking_number","slug"],"title":"NestedCreateParcelShipmentParams","type":"object"},"Airline":{"description":"This schema defines an 'Airline' data structure.","example":{"callsign":"AMERICAN","hub_code":"DFW","iata_code":"AA","icao_code":"AAL","id":1,"name":"American Airlines"},"properties":{"callsign":{"description":"The radio callsign, a unique identifier used in air traffic control communications.","nullable":true,"type":"string"},"hub_code":{"description":"The hub code of the airline's primary operational hub, indicating the central Airport.","nullable":true,"type":"string"},"iata_code":{"description":"The IATA (International Air Transport Association) code.","nullable":true,"type":"string"},"icao_code":{"description":"The ICAO (International Civil Aviation Organization) code.","nullable":true,"type":"string"},"id":{"description":"The unique identifier for the Airline.","type":"integer"},"name":{"description":"The name of the Airline.","type":"string"}},"required":["id","name"],"title":"Airline","type":"object"},"NestedUpsertHandlersByRoleParams":{"description":"Available nested parameters to upsert a Handlers By Roles.","example":{"acquirer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"agent":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"bank":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"bonded_terminal":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"cargo_owner":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"container_depot":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customs_broker":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customs_terminal":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"exporter":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"freight_forwarder":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"funder":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"importer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"integrator":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"international_road_carrier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"manufacturer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"national_road_carrier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"supplier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"trading":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"warehouse":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}]},"properties":{"acquirer":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"agent":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"bank":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"bonded_terminal":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"cargo_owner":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"container_depot":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"customer":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"customs_broker":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"customs_terminal":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"exporter":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"freight_forwarder":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"funder":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"importer":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"integrator":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"international_road_carrier":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"manufacturer":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"national_road_carrier":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"supplier":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"trading":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"warehouse":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"}},"title":"NestedUpsertHandlersByRoleParams","type":"object"},"CostModelExpense":{"description":"This schema defines an 'Cost ModelExpense' data structure.","example":{"cost_expense":{"id":123,"name":"Cost Expense","slug":"cost_expense"},"dynamic_table_definition_id":null,"id":123,"matching_rules":null,"precification_model":null,"price_field":null,"reference":null,"reference_value":null},"properties":{"cost_expense":{"additionalProperties":{"$ref":"#/components/schemas/CostExpense"},"type":"object"},"dynamic_table_definition_id":{"description":"A reference of Dynamic Table Definition ID from planned Cost Model Expense","nullable":true,"type":"number"},"fallback_path":{"description":"A fallback path field from planned cost Cost Model Expense.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Cost Model Expense.","type":"integer"},"matching_rules":{"description":"An array of Matching Rules from a planned Cost Model Expense.","items":{"additionalProperties":{"$ref":"#/components/schemas/MatchingRule"},"type":"object"},"nullable":true,"type":"array"},"precification_model":{"description":"A precification model from a planned Cost Model Expense.","enum":["FIXED","LOOKUP","LOOKUP_MULTIPLY","MULTIPLY","NONE","COPY_REALIZED"],"nullable":true,"type":"string"},"price_field":{"description":"A Price Field reference in the Dynamic Table Definition from a planned Cost Model Expense.","nullable":true,"type":"string"},"reference":{"description":"A reference from a planned Cost Model Expense.","enum":["CONTAINERS","CONTAINERS_ROUTE","ITEMS_CONTENT_QUANTITY","ITEMS_CUBAGE_CUBIC_METERS","BRAZILIAN_INVOICE_VALUE","ORDER","ITEMS_PALLETS","ITEMS_QUANTITY","SHIPMENT","STORAGE_DAYS_CONTAINER","STORAGE_PERIOD","ITEMS_UNITIZED_QUANTITY","ITEMS_WEIGHT_KG","FREIGHT_COST","CALCULATED_GROSS_WEIGHT_KG","CALCULATED_CUBAGE_CUBIC_METERS"],"nullable":true,"type":"string"},"reference_value":{"description":"A reference value from a planned Cost Model Expense.","format":"decimal","nullable":true,"type":"string"}},"required":["id","cost_expense"],"title":"CostModelExpense","type":"object"},"OperationHandler":{"description":"This schema defines an 'OperationHandler' data structure.","example":{"id":1,"role":"CARGO_OWNER"},"properties":{"id":{"description":"Unique identifier for the Handler.","type":"integer"},"role":{"description":"The role of this handler in the operation.","enum":["ACQUIRER","AGENT","BANK","BONDED_TERMINAL","CARGO_OWNER","CONTAINER_DEPOT","CUSTOMER","CUSTOMS_BROKER","CUSTOMS_TERMINAL","EXPORTER","FUNDER","FREIGHT_FORWARDER","IMPORTER","INTEGRATOR","INTERNATIONAL_ROAD_CARRIER","MANUFACTURER","NATIONAL_ROAD_CARRIER","SUPPLIER","TRADING","WAREHOUSE"],"type":"string"}},"required":["id","role"],"title":"OperationHandler","type":"object"},"Order":{"description":"This schema defines an 'Order' data structure.","example":{"canceled_at":null,"deleted_at":null,"external_reference_code":"ECT1","extra_fields":{},"finished_at":null,"handlers":[{"actor":{"cnae":"","contact_details":"Contact Details","description":"Description","document_type":"CNPJ","id":1,"internal_code":"123123","logo_url":null,"nickname":"Nickname","official_document":"11111111111111","official_name":"Actor","opening_date":"2023-01-01","roles":[{"access_group":{"slug":"access_group"},"role":"CARGO_OWNER"}],"trading_name":"Trading Name","verified":true},"business_unit":"Business Unit","id":1,"operation_handler":{"id":1,"role":"CARGO_OWNER"},"reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"id":123,"inserted_at":"2023-10-29T00:00:00Z","observations":"Observations...","operation":{"id":1},"processes":[{"id":1,"reference_code":"23PRC0000001"},{"id":2,"reference_code":"23PRC0000002"}],"purchase_order":{"id":123,"items":[{"net_weight_kg":null,"order_value":null,"shipment_estimated_boarding_at":null,"supplier_confirmation_at":null,"shipment_boarding_lead_time":null,"order_currency":{"code":"USD","name":"US Dollar"},"line_number":1,"line_reference":"1.1","customs_release_lead_time":null,"order_unit_value":null,"shipment_estimated_arrival_at":null,"import_type_sap":null,"manufacturing_country":{"code":"BR","name":"Brazil"},"shipment_planned_boarding_at":null,"sap_by_factor":null,"order_modal_type_sap":null,"shipping_details_delivery_date":null,"shipment_equipment_type":null,"order_item_reference":null,"dispatching_country":{"code":"BR","name":"Brazil"},"factory_estimated_delivery_at":null,"delivery_note":null,"factory_delivery_lead_time":null,"adjusted_factory_delivery_lead_time":null,"assessment_sotd":null,"planning_request_shipping_at":null,"order_adjusted_modal_type":null,"order_request_number":null,"concession_act":null,"customs_estimated_release_at":null,"quotation_opening_date":null,"adjusted_customs_release_lead_time":null,"measurement_unit_sap":null,"shipment_transport_lead_time":null,"id":123,"order_requested_at":null,"delivery_note_issued_at":null,"gross_weight_kg":null,"purchase_country":{"code":"BR","name":"Brazil"},"supplier_ready_lead_time_days":null,"quantity":"20.0","invoice_issued_at":null,"shipment_planned_arrival_at":null,"product_description":"Descrição Produto","supplier_estimated_ready_at":null,"invoice_value":null,"product_mercosul_code":"8708.80.00","customs_register_lead_time":null,"adjusted_shipment_transport_lead_time":null,"planning_shipping_at":null,"balance":"10.0","invoice_number":null,"adjusted_customs_register_lead_time":null,"customs_estimated_register_at":null,"balance_shipped":"10.0","order_total_value":null,"shipment_containers_quantity":null,"supplier_sent_at":null,"supplier_ready_at":null,"factory_delivery_at":null,"factory_planned_delivery_at":null,"invoice_type":null,"adjusted_shipment_boarding_lead_time":null,"item_status":null,"product":{"code":"REF1234","description":"Descrição Produto","id":2,"mercosul_code":"8708.80.00","package_type":"BOTTLES"},"adjusted_supplier_ready_lead_time_days":null,"supplier_planned_ready_at":null,"supplier_calculated_ready_at":null,"cubage_cubic_meters":null}],"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","sales_order":null,"subsidiary":{"id":1,"name":"Subsidiary"},"type":"PURCHASE"},"properties":{"canceled_at":{"description":"The timestamp indicating when the order was canceled. Format: ISO 8601 'date-time'.","format":"date-time","nullable":true,"type":"string"},"deleted_at":{"description":"The timestamp indicating when the order was deleted. Format: ISO 8601 'date-time'.","format":"date-time","nullable":true,"type":"string"},"external_reference_code":{"description":"An external reference code associated with the Order.","nullable":true,"type":"string"},"finished_at":{"description":"The timestamp indicating when the order was finished. Format: ISO 8601 'date-time'.","format":"date-time","nullable":true,"type":"string"},"handlers":{"description":"An array of Handlers responsible for managing this Order.","items":{"$ref":"#/components/schemas/Handler"},"type":"array"},"id":{"description":"Unique identifier for the Order.","type":"integer"},"inserted_at":{"description":"Date and time when the Order information was inserted.","format":"date-time","type":"string"},"observations":{"description":"Textual field for recording observations or comments related to the PO.","nullable":true,"type":"string"},"operation":{"properties":{"id":{"description":"Unique identifier for the Operation","type":"integer"}},"required":["id"],"type":"object"},"processes":{"description":"An array of Processes associated with this Order.","items":{"properties":{"id":{"description":"Unique identifier for the Process.","type":"integer"},"reference_code":{"description":"A reference code associated with the Process.","type":"string"}},"type":"object"},"type":"array"},"purchase_order":{"additionalProperties":{"$ref":"#/components/schemas/PurchaseOrder"},"description":"A Purchase Order associated with this Order.","nullable":true},"reference_code":{"description":"A reference code associated with the Order.","type":"string"},"sales_order":{"additionalProperties":{"$ref":"#/components/schemas/SalesOrder"},"description":"A Sales Order associated with this Order.","nullable":true},"subsidiary":{"additionalProperties":{"$ref":"#/components/schemas/Subsidiary"},"description":"A Subsidiary associated with this Order.","nullable":true},"type":{"description":"Type of the Order.","enum":["ROAD_TRANSPORT","PURCHASE","SALES"],"type":"string"}},"required":["id","operation","reference_code","type","inserted_at"],"title":"Order","type":"object"},"ActorResponse":{"description":"Schema representing the response for a single actor. Contains actor data.","properties":{"data":{"$ref":"#/components/schemas/Actor"}},"title":"ActorResponse","type":"object"},"NestedCreatePurchaseOrderParams":{"description":"Available parameters to create a Purchase Order (PO).","example":{"items":[{"net_weight_kg":null,"order_value":null,"shipment_estimated_boarding_at":null,"supplier_confirmation_at":null,"shipment_boarding_lead_time":null,"manufacturing_country_code":"BR","line_number":1,"line_reference":"1.1","customs_release_lead_time":null,"order_unit_value":null,"shipment_estimated_arrival_at":null,"import_type_sap":null,"shipment_planned_boarding_at":null,"sap_by_factor":null,"order_modal_type_sap":null,"shipping_details_delivery_date":null,"shipment_equipment_type":null,"order_item_reference":null,"factory_estimated_delivery_at":null,"delivery_note":null,"factory_delivery_lead_time":null,"adjusted_factory_delivery_lead_time":null,"product_code":"PRD-123","assessment_sotd":null,"planning_request_shipping_at":null,"order_adjusted_modal_type":null,"order_request_number":null,"concession_act":null,"customs_estimated_release_at":null,"purchase_country_code":"BR","quotation_opening_date":null,"adjusted_customs_release_lead_time":null,"measurement_unit_sap":null,"shipment_transport_lead_time":null,"order_requested_at":null,"delivery_note_issued_at":null,"gross_weight_kg":null,"supplier_ready_lead_time_days":null,"quantity":"20.0","invoice_issued_at":null,"shipment_planned_arrival_at":null,"supplier_estimated_ready_at":null,"order_currency_code":"USD","invoice_value":null,"customs_register_lead_time":null,"adjusted_shipment_transport_lead_time":null,"planning_shipping_at":null,"invoice_number":null,"adjusted_customs_register_lead_time":null,"customs_estimated_register_at":null,"shipment_containers_quantity":null,"product_id":1,"supplier_sent_at":null,"supplier_ready_at":null,"dispatching_country_code":"BR","factory_delivery_at":null,"factory_planned_delivery_at":null,"item_foreign_operators":[],"invoice_type":null,"adjusted_shipment_boarding_lead_time":null,"item_status":null,"adjusted_supplier_ready_lead_time_days":null,"supplier_planned_ready_at":null,"supplier_calculated_ready_at":null,"cubage_cubic_meters":null}],"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"},"properties":{"items":{"items":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreatePurchaseOrderItemParams"},"description":"Details of the Items associated with this PO."},"type":"array"},"necessity_date":{"description":"The timestamp serving as the reference point for the necessity of the PO.","format":"date-time","nullable":true,"type":"string"},"supplier_expected_readiness_at":{"description":"The timestamp serving as the reference point for the supplier's expected readiness of the PO.","format":"date-time","nullable":true,"type":"string"},"supplier_order_accepted_at":{"description":"The timestamp that serves as a reference point for the supplier's acceptance of the PO.","format":"date-time","nullable":true,"type":"string"},"supplier_order_sent_at":{"description":"The timestamp that serves as a reference point for sending the order to the supplier.","format":"date-time","nullable":true,"type":"string"},"supplier_readiness_at":{"description":"The timestamp serving as the reference point for the supplier's availability of the PO.","format":"date-time","nullable":true,"type":"string"},"type":{"description":"Type indicating the type of acquisition of the PO.","enum":["DIRECT","INDIRECT"],"type":"string"}},"required":["type"],"title":"NestedCreatePurchaseOrderParams","type":"object"},"UpdateOrderParams":{"description":"Available parameters to update an Order.","example":{"params":{"external_reference_code":"","handler":{"acquirer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"agent":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"bank":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"bonded_terminal":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"cargo_owner":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"container_depot":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customs_broker":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customs_terminal":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"exporter":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"freight_forwarder":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"funder":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"importer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"integrator":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"international_road_carrier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"manufacturer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"national_road_carrier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"supplier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"trading":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"warehouse":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}]},"handlers":[],"observations":"Observations...","purchase_order":{"items":[{"net_weight_kg":null,"order_value":null,"shipment_estimated_boarding_at":null,"supplier_confirmation_at":null,"shipment_boarding_lead_time":null,"manufacturing_country_code":"BR","line_number":1,"line_reference":"1.1","customs_release_lead_time":null,"order_unit_value":null,"shipment_estimated_arrival_at":null,"import_type_sap":null,"shipment_planned_boarding_at":null,"sap_by_factor":null,"order_modal_type_sap":null,"shipping_details_delivery_date":null,"shipment_equipment_type":null,"order_item_reference":null,"factory_estimated_delivery_at":null,"delivery_note":null,"factory_delivery_lead_time":null,"adjusted_factory_delivery_lead_time":null,"product_code":"PRD-123","assessment_sotd":null,"planning_request_shipping_at":null,"order_adjusted_modal_type":null,"order_request_number":null,"concession_act":null,"customs_estimated_release_at":null,"purchase_country_code":"BR","quotation_opening_date":null,"adjusted_customs_release_lead_time":null,"measurement_unit_sap":null,"shipment_transport_lead_time":null,"id":1,"order_requested_at":null,"delivery_note_issued_at":null,"gross_weight_kg":null,"supplier_ready_lead_time_days":null,"quantity":"20.0","invoice_issued_at":null,"shipment_planned_arrival_at":null,"supplier_estimated_ready_at":null,"order_currency_code":"USD","invoice_value":null,"customs_register_lead_time":null,"adjusted_shipment_transport_lead_time":null,"planning_shipping_at":null,"invoice_number":null,"adjusted_customs_register_lead_time":null,"customs_estimated_register_at":null,"shipment_containers_quantity":null,"product_id":1,"supplier_sent_at":null,"supplier_ready_at":null,"dispatching_country_code":"BR","factory_delivery_at":null,"factory_planned_delivery_at":null,"item_foreign_operators":[],"invoice_type":null,"adjusted_shipment_boarding_lead_time":null,"item_status":null,"adjusted_supplier_ready_lead_time_days":null,"supplier_planned_ready_at":null,"supplier_calculated_ready_at":null,"cubage_cubic_meters":null}],"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"}}},"properties":{"params":{"properties":{"external_reference_code":{"description":"An external reference code associated with the Order.","nullable":true,"type":"string"},"handler":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpsertHandlersByRoleParams"},"description":"Handlers responsible for managing this Process by Role."},"handlers":{"deprecated":true,"description":"An array of Handlers responsible for managing this Order.","items":{"$ref":"#/components/schemas/NestedUpdateHandlerParams"},"type":"array"},"observations":{"description":"Textual field for recording observations or comments related to the PO.","nullable":true,"type":"string"},"purchase_order":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdatePurchaseOrderParams"},"description":"A Purchase Order (PO) associated with this Order."},"sales_order":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateSalesOrderParams"},"description":"A Sales Order (SO) associated with this Order."},"subsidiary_id":{"description":"Unique identifier for the Subsidiary.","nullable":true,"type":"integer"}},"type":"object"}},"title":"UpdateOrderParams","type":"object"},"NestedUpdateAirTransportShipmentParams":{"description":"Available nested parameters to update an Air Transport Shipment.","example":{"airline_id":1,"awb":"123-45678901","destination_airport_id":1,"hawb":"HAWB-123456","origin_airport_id":2736,"type":"ENVIROTAINER"},"properties":{"airline_id":{"description":"Unique identifier for the Airline.","nullable":true,"type":"integer"},"awb":{"description":"Air Waybill (AWB) number associated with the Shipment.","nullable":true,"type":"string"},"destination_airport_id":{"description":"Unique identifier for the Destination Airport.","nullable":true,"type":"integer"},"hawb":{"description":"House Air Waybill (HAWB) number associated with the Shipment.","nullable":true,"type":"string"},"origin_airport_id":{"description":"Unique identifier for the Origin Airport.","nullable":true,"type":"integer"},"type":{"description":"Type of Shipment.","enum":["ENVIROTAINER","PALLET","LOOSE_CARGO"],"nullable":true,"type":"string"}},"title":"NestedUpdateAirTransportShipmentParams","type":"object"},"NestedUpdateRoadTransportTripParams":{"description":"Available nested parameters to update a Foreign Trade Road Transport Trip.","example":{"driver_id":123,"driver_name":"John Doe","id":1,"phases":[{"departure_at":"2023-10-29T00:00:00Z","estimated_realized_at":"2023-10-29T00:00:00Z","realized_at":"2023-10-29T00:00:00Z","route_point_id":1},{"departure_at":"2023-10-29T00:00:00Z","estimated_realized_at":"2023-10-29T00:00:00Z","realized_at":"2023-10-29T00:00:00Z","route_point_id":2}],"position":123,"trailer_id":123,"trailer_plate":"XYZ456","transportable_ids":[123,124],"vehicle_id":null,"vehicle_plate":"ABC123"},"properties":{"driver_id":{"description":"Unique identifier for the Driver.","type":"integer"},"driver_name":{"description":"The name of the Driver.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Road Transport Trip.","type":"integer"},"phases":{"items":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateRoadTransportTripPhaseParams"},"description":"Details of different Phases of the Trip."},"type":"array"},"position":{"description":"The position of the Trip in order.","type":"integer"},"trailer_id":{"description":"Unique identifier for the Trailer.","type":"integer"},"trailer_plate":{"description":"The plate of the associated Trailer.","nullable":true,"type":"string"},"transportable_ids":{"items":{"description":"Unique identifiers for Transportables.","type":"integer"},"type":"array"},"vehicle_id":{"description":"Unique identifier for the Vehicle.","type":"integer"},"vehicle_plate":{"description":"The plate of the associated Vehicle.","nullable":true,"type":"string"}},"title":"NestedUpdateRoadTransportTripParams","type":"object"},"CostPerExpenseMutationResponse":{"description":"An array containing details of multiple Cost Per Expenses.","properties":{"data":{"items":{"description":"This schema defines an 'Cost Per Expense' data structure.","properties":{"cost":{"description":"Cost Per Expense cost value.","format":"decimal","type":"string"},"id":{"description":"Cost Per Expense identifier.","type":"integer"},"planned_cost":{"description":"Cost Per Expense planned cost value.","format":"decimal","nullable":true,"type":"string"}},"required":["id","cost"],"type":"object"},"type":"array"}},"title":"CostPerExpenseMutationResponse","type":"object"},"Country":{"description":"This schema defines a 'Country' data structure.","example":{"code":"BR","iso3":"BRA","name":"Brazil"},"properties":{"code":{"description":"The Country code or ISO 3166-1 alpha-2 code.","type":"string"},"iso3":{"description":"The ISO 3166-1 alpha-3 Country code.","nullable":true,"type":"string"},"name":{"description":"The name of the Country.","type":"string"}},"required":["code","name"],"title":"Country","type":"object"},"UpsertHandlersParams":{"description":"A list of Upsert Handler Params.","items":{"$ref":"#/components/schemas/UpsertHandlerParams"},"title":"UpsertHandlersParams","type":"array"},"NestedCreateTransportableParams":{"description":"Available nested parameters to create a Transportable.","example":{"cargo":null,"container":{"code":"MSDU5953962","cubic_meters":30.0,"demurrage_free_time_start_at":"2023-01-01T00:00:00Z","dispatch_number":"DISP12345","gross_weight_kg":"100.10","hidden":false,"invoice_number":"99999","is_stackable":true,"load_type":"GENERAL_CARGO","max_weight_kg":"100.123","observations":"observation example","seal_code":"SEAL_CODE","secondary_seal_code":"SECONDARY_SEAL_CODE","size_foot_type":"20_FOOT","tare_weight_kg":"100","tracking_manual":true,"transport_document":"TDOC67890","type":"DRY"}},"properties":{"cargo":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateCargoParams"},"description":"Details of the Cargo if the Transportable is of type 'cargo'.","nullable":true},"container":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateContainerParams"},"description":"Details of the Container if the Transportable is of type 'container'.","nullable":true}},"title":"NestedCreateTransportableParams","type":"object"},"Handler":{"description":"This schema defines a 'Handler' data structure.","example":{"actor":{"cnae":"","contact_details":"Contact Details","description":"Description","document_type":"CNPJ","id":1,"internal_code":"123123","logo_url":null,"nickname":"Nickname","official_document":"11111111111111","official_name":"Actor","opening_date":"2023-01-01","roles":[{"access_group":{"slug":"access_group"},"role":"CARGO_OWNER"}],"trading_name":"Trading Name","verified":true},"business_unit":"Business Unit","id":1,"operation_handler":{"id":1,"role":"CARGO_OWNER"},"reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"},"properties":{"actor":{"additionalProperties":{"$ref":"#/components/schemas/Actor"},"description":"Additional Handler Information."},"business_unit":{"description":"Describes the business unit associated with the Handler.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Handler.","type":"integer"},"operation_handler":{"additionalProperties":{"$ref":"#/components/schemas/OperationHandler"},"description":"Additional Handler Information."},"reference":{"description":"Represents am identifier for the Handler.","nullable":true,"type":"string"},"secondary_reference":{"description":"Provides an additional reference for the Handler.","nullable":true,"type":"string"}},"required":["id","actor","operation_handler"],"title":"Handler","type":"object"},"NestedCreateDemurrageParams":{"description":"Available nested parameters to create a Demurrage.","example":{"daily_rate_usd":"10.5","free_time":2},"properties":{"daily_rate_usd":{"description":"The daily rate in USD charged for Demurrage after the free time has expired.","format":"number","type":"string"},"free_time":{"description":"The number of days allowed for free time before Demurrage charges apply.","type":"integer"}},"required":["free_time","daily_rate_usd"],"title":"NestedCreateDemurrageParams","type":"object"},"NestedCreateMaritimeTransportShipmentParams":{"description":"Available nested parameters to create a Maritime Transport Shipment.","example":{"bl":"MEDUGB760924","booking":null,"discharge_port_id":2,"hbl":null,"loading_port_id":1,"sealine_id":1,"tracking_discharge_port":"BRRIG","tracking_loading_port":"CNNGB","tracking_number":null,"type":"FCL","vessel_id":123,"voyage_number":"CNNGBTRB"},"properties":{"bl":{"description":"Bill of Lading (BL) reference related to the Shipment.","nullable":true,"type":"string"},"booking":{"description":"Booking reference related to the Shipment.","nullable":true,"type":"string"},"discharge_port_id":{"description":"Unique identifier for the Discharge Port.","nullable":true,"type":"integer"},"hbl":{"description":"House Bill of Lading (HBL) reference related to the Shipment.","nullable":true,"type":"string"},"loading_port_id":{"description":"Unique identifier for the Loading Port.","nullable":true,"type":"integer"},"sealine_id":{"description":"Unique identifier for the Sealine.","nullable":true,"type":"integer"},"tracking_discharge_port":{"description":"The Discharge Port found by Automatic Tracking.","nullable":true,"type":"string"},"tracking_loading_port":{"description":"The Loading Port found by Automatic Tracking.","nullable":true,"type":"string"},"tracking_number":{"description":"Tracking Number reference related to the Shipment.","nullable":true,"type":"string"},"type":{"description":"The Type of Maritime Transport.","enum":["FCL","LCL","BREAKBULK","BULK_CARGO"],"nullable":true,"type":"string"},"vessel_id":{"description":"Unique identifier for the Vessel.","nullable":true,"type":"integer"},"voyage_number":{"description":"Identifier of the Voyage.","nullable":true,"type":"string"}},"title":"NestedCreateMaritimeTransportShipmentParams","type":"object"},"NestedCreateCargoParams":{"description":"Available nested parameters to create a Cargo.","example":{"cubic_weight":"200","dimensions":"2 3 4","measurement_unit":"KILOGRAMS","quantity":"100","volume_cubic_meters":"10","weight_kg":"100"},"properties":{"cubic_weight":{"description":"The cubic weight of the Cargo.","nullable":true,"type":"string"},"dimensions":{"description":"Dimensions of the Cargo.","nullable":true,"type":"string"},"measurement_unit":{"description":"The unit of measurement used for the Cargo.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"type":"string"},"quantity":{"description":"Quantity of the Cargo.","type":"string"},"volume_cubic_meters":{"description":"Volume of the Cargo in cubic meters.","nullable":true,"type":"string"},"weight_kg":{"description":"Weight of the Cargo linked to the measurement unit.","nullable":true,"type":"string"}},"required":["measurement_unit","quantity"],"title":"NestedCreateCargoParams","type":"object"},"NestedUpdateContainerParams":{"description":"Available nested parameters to update a Container.","example":{"code":"MSDU5953962","cubic_meters":30.0,"demurrage_free_time_start_at":"2023-01-01T00:00:00Z","dispatch_number":"DISP12345","gross_weight_kg":"100.10","hidden":false,"id":1,"invoice_number":"99999","is_stackable":true,"load_type":"GENERAL_CARGO","max_weight_kg":"100.123","observations":"observation example","seal_code":"SEAL_CODE","secondary_seal_code":"SECONDARY_SEAL_CODE","size_foot_type":"20_FOOT","tare_weight_kg":"100","tracking_manual":true,"transport_document":"TDOC67890","type":"DRY"},"properties":{"code":{"description":"A code associated with the Container.","type":"string"},"cubic_meters":{"description":"The cubic meter the Container.","format":"number","type":"string"},"demurrage_free_time_start_at":{"description":"The starting point to count the container's Free Time before demurrage costs incur.","format":"date-time","nullable":true,"type":"string"},"dispatch_number":{"description":"The Dispatch number.","nullable":true,"type":"string"},"gross_weight_kg":{"description":"Gross weight of the Container in kilograms.","format":"decimal","nullable":true,"type":"string"},"hidden":{"description":"Flag to determine whether the Container should be hidden.","type":"boolean"},"id":{"description":"Unique identifier for the Container.","type":"integer"},"invoice_number":{"description":"Invoice number associated with the Container.","nullable":true,"type":"string"},"is_stackable":{"description":"If is stackable Container.","format":"boolean","type":"string"},"load_type":{"description":"Type of Cargo the Container is designed.","enum":["GENERAL_CARGO","FOOD","PHARMACEUTICALS","WEAPONS","BULK"],"nullable":true,"type":"string"},"max_weight_kg":{"description":"Maximum weight capacity of the Container in kilograms.","format":"decimal","nullable":true,"type":"string"},"observations":{"description":"Container observations.","nullable":true,"type":"string"},"seal_code":{"description":"Code associated with Container Seals.","nullable":true,"type":"string"},"secondary_seal_code":{"description":"Secondary code for Container Seals.","nullable":true,"type":"string"},"size_foot_type":{"description":"Size of the Container in foot.","enum":["STANDARD_10","STANDARD_20","STANDARD_30","STANDARD_40","SPECIAL_20","SPECIAL_30","SPECIAL_40","SPECIAL_45","REDUCED_20","REDUCED_30","REDUCED_40","HC_20","HC_40","HC_45","SHC_20","SHC_40","SHC_45","PALLET_WIDE_40","PALLET_WIDE_45"],"nullable":true,"type":"string"},"tare_weight_kg":{"description":"Tare weight of the Container in kilograms.","format":"decimal","nullable":true,"type":"string"},"tracking_manual":{"default":true,"description":"Flag to determine whether the Container was created or edited manually.","type":"boolean"},"transport_document":{"description":"The Transport Document.","nullable":true,"type":"string"},"type":{"description":"Type of the container.","enum":["BULK","DOUBLE_DOOR","DRY","FLAT_RACK","HARD_TOP","HIGH_CUBE","INSULATED","NON_OPERATING_REEFER","OPEN_TOP","PALLET_WIDE","PLATFORM","REEFER","SIDE_DOOR","SPECIAL","STANDARD","SWAP_BODY","TANK","VENTILATED"],"nullable":true,"type":"string"}},"title":"NestedUpdateContainerParams","type":"object"},"ContainerEvent":{"description":"This schema defines a 'ContainerEvent' data structure.","example":{"datetime":"2024-06-25T14:07:32Z","estimated":false,"place":"Houston","status":"CLL","transport":"HELLA","voyage":"9588"},"properties":{"datetime":{"description":"The Datetime of the Container Event.","format":"date-time","type":"string"},"estimated":{"description":"The Estimated of the Container Event.","type":"boolean"},"place":{"description":"The Place of the Container Event.","type":"string"},"status":{"description":"The Status of the Container Event.","type":"string"},"transport":{"description":"The Transport of the Container Event.","type":"string"},"voyage":{"description":"The Voyage of the Container Event.","type":"string"}},"title":"ContainerEvent","type":"object"},"Document":{"description":"This schema defines a 'Document' data structure.","example":{"description":"The description of Document","external_id":"1234","id":1,"original_filename":"shipment_document.pdf","type":"SHIPMENT_DOCUMENT"},"properties":{"description":{"description":"The description of the Document.","nullable":true,"type":"string"},"external_id":{"description":"The external id of the Document.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Document.","type":"integer"},"original_filename":{"description":"The original file name of the Document.","type":"string"},"type":{"description":"The type of Document.","enum":["ANALYSIS_CERTIFICATE","BILL_OF_LADING","BOOKING","BRAZILIAN_INVOICE","COLLECT_ORDER","COMMERCIAL_INVOICE","CONTAINER_ARRIVAL_NOTICE","CONTAINER_DAMAGE","CONTAINER_PROOF_OF_RETURN","CORRECTION_LETTER","CUSTOMS_TRANSIT_DECLARATION","DANGEROUS_GOODS_REQUEST","DI_RECTIFICATION_STATEMENT","DRAUGHT_REPORT","EXPORT_DECLARATION","EXPORT_DECLARATION_DUE","FREIGHT_QUOTE","FREIGHT_RECEIPTS","FUMIGATION_CERTIFICATE","GRU_ANVISA","HEALTH_CERTIFICATE","ICMS","IMPORT_DECLARATION","IMPORT_DECLARATION_DI","IMPORT_DECLARATION_DUIMP","IMPORT_LICENSE","IMPORT_LICENSE_LI","INSPECTION_CERTIFICATE","INSURANCE_POLICY","INVOICE","LPCO","MAPA_APPROVAL","MDFE","MERCHANT_MARINE_DOCUMENT","ORDER_CONFIRMATION","ORIGIN_CERTIFICATE","OTHER","PACKING_LIST","PHYTOSANITARY_CERTIFICATE","PROFORMA_INVOICE","PROOF_OF_DELIVERY","PURCHASE_ORDER","QUALITY_CERTIFICATE","SALES_ORDER","SHIPPING_ADVICE","SHIPPING_INSTRUCTIONS","TRANSPORT_ACKNOWLEDGMENT","VETERINARY_CERTIFICATE","WEIGHT_AND_QUALITY_CERTIFICATE","WEIGHT_CERTIFICATE","HAWB","CRT","SHIPMENT_DOCUMENT","FOREIGN_EXCHANGE_CONTRACT","PROOF_OF_PAYMENT","SHIPPING_DOCUMENTS_FOR_APPROVAL","APPROVED_SHIPPING_DOCUMENTS","SHIPMENT_PRE_ALERT","DEBIT_NOTE","SALES_CONTRACT","DATE_CERTIFICATE","CARBENDAZIM_TEST_REPORT","WOOD_PACKAGING_DECLARATION","ADDITIONAL_INSURANCE_DOCUMENTS","MIC","DRAFT_CO","DRAFT_BL","ISF_5","ISF_10","LAB_ANALYSIS_REPORT","SANITARY_CERTIFICATE","COST_CLOSING","STUFFING_PLAN"],"type":"string"}},"required":["id","type","original_filename"],"title":"Document","type":"object"},"CostModelResponse":{"description":"Schema representing the response for a single cost model. Contains cost model data.","properties":{"data":{"$ref":"#/components/schemas/CostModelFullObject"}},"title":"CostModelResponse","type":"object"},"NestedUpdateForeignTradeItemShipmentParams":{"description":"Available parameters to update a Foreign Trade Item Shipment.","example":{"brazilian_invoice_unit_value":"10","cubage_cubic_meters":null,"gross_weight_kg":null,"id":1,"line_reference":null,"net_weight_kg":"0.5","order_reference_code":null,"purchase_order_item_id":1,"quantity":"10","sales_order_item_id":null,"unit_value":"10"},"properties":{"brazilian_invoice_unit_value":{"description":"The brazilian invoice unit value of this item in this Shipment.","format":"number","nullable":true,"type":"string"},"cubage_cubic_meters":{"description":"Cubage in cubic meters of this item in this Shipment.","format":"number","nullable":true,"type":"string"},"gross_weight_kg":{"description":"The gross weight in kilograms of this item in this Shipment.","format":"number","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Shipment Item.","type":"integer"},"line_reference":{"description":"The Line Reference of the Order Item.","nullable":true,"type":"string"},"net_weight_kg":{"description":"The net weight of this item in this Shipment.","format":"number","nullable":true,"type":"string"},"order_reference_code":{"description":"The Reference Code of the associated Order.","nullable":true,"type":"string"},"purchase_order_item_id":{"description":"Unique identifier for the POI.","nullable":true,"type":"integer"},"quantity":{"description":"The number of products in this Shipment that originated from the associated Order.","format":"number","nullable":true,"type":"string"},"sales_order_item_id":{"description":"Unique identifier for the SOI.","nullable":true,"type":"integer"},"unit_value":{"description":"The unit value of this item in this Shipment.","format":"number","nullable":true,"type":"string"}},"title":"NestedUpdateForeignTradeItemShipmentParams","type":"object"},"NestedUpdatePurchaseOrderItemParams":{"description":"Available parameters to update a Purchase Order Item (POI).","example":{"net_weight_kg":null,"order_value":null,"shipment_estimated_boarding_at":null,"supplier_confirmation_at":null,"shipment_boarding_lead_time":null,"manufacturing_country_code":"BR","line_number":1,"line_reference":"1.1","customs_release_lead_time":null,"order_unit_value":null,"shipment_estimated_arrival_at":null,"import_type_sap":null,"shipment_planned_boarding_at":null,"sap_by_factor":null,"order_modal_type_sap":null,"shipping_details_delivery_date":null,"shipment_equipment_type":null,"order_item_reference":null,"factory_estimated_delivery_at":null,"delivery_note":null,"factory_delivery_lead_time":null,"adjusted_factory_delivery_lead_time":null,"product_code":"PRD-123","assessment_sotd":null,"planning_request_shipping_at":null,"order_adjusted_modal_type":null,"order_request_number":null,"concession_act":null,"customs_estimated_release_at":null,"purchase_country_code":"BR","quotation_opening_date":null,"adjusted_customs_release_lead_time":null,"measurement_unit_sap":null,"shipment_transport_lead_time":null,"id":1,"order_requested_at":null,"delivery_note_issued_at":null,"gross_weight_kg":null,"supplier_ready_lead_time_days":null,"quantity":"20.0","invoice_issued_at":null,"shipment_planned_arrival_at":null,"supplier_estimated_ready_at":null,"order_currency_code":"USD","invoice_value":null,"customs_register_lead_time":null,"adjusted_shipment_transport_lead_time":null,"planning_shipping_at":null,"invoice_number":null,"adjusted_customs_register_lead_time":null,"customs_estimated_register_at":null,"shipment_containers_quantity":null,"product_id":1,"supplier_sent_at":null,"supplier_ready_at":null,"dispatching_country_code":"BR","factory_delivery_at":null,"factory_planned_delivery_at":null,"item_foreign_operators":[],"invoice_type":null,"adjusted_shipment_boarding_lead_time":null,"item_status":null,"adjusted_supplier_ready_lead_time_days":null,"supplier_planned_ready_at":null,"supplier_calculated_ready_at":null,"cubage_cubic_meters":null},"properties":{"net_weight_kg":{"description":"Net weight in kilograms.","format":"number","nullable":true,"type":"string"},"order_value":{"description":"Order Value.","format":"number","nullable":true,"type":"string"},"shipment_estimated_boarding_at":{"description":"Shipment Estimated Boarding At.","format":"date-time","nullable":true,"type":"string"},"supplier_confirmation_at":{"description":"Supplier Confirmation At.","format":"date-time","nullable":true,"type":"string"},"manufacturing_country_code":{"description":"Manufacturing Country Code.","nullable":true,"type":"string"},"line_number":{"description":"The line number associated with this POI.","nullable":true,"type":"integer"},"line_reference":{"description":"The line reference associated with this POI.","type":"string"},"customs_release_lead_time":{"description":"Customs release Lead Time in Days.","nullable":true,"type":"integer"},"order_unit_value":{"description":"Order Unit Value.","format":"number","nullable":true,"type":"string"},"shipment_estimated_arrival_at":{"description":"Shipment Estimated Arrival At.","format":"date-time","nullable":true,"type":"string"},"import_type_sap":{"description":"Import type from SAP.","nullable":true,"type":"string"},"division":{"description":"Item Division","nullable":true,"type":"string"},"shipment_planned_boarding_at":{"description":"Shipment Planned Boarding At.","format":"date-time","nullable":true,"type":"string"},"sap_by_factor":{"description":"POR factor from SAP.","format":"number","nullable":true,"type":"string"},"order_modal_type_sap":{"description":"Order Modal Type from SAP.","nullable":true,"type":"string"},"shipping_details_delivery_date":{"description":"Shipping Details Delivery Date.","format":"date","nullable":true,"type":"string"},"shipment_equipment_type":{"description":"Shipment Equipment Type.","nullable":true,"type":"string"},"order_item_reference":{"description":"Order Item Reference.","nullable":true,"type":"string"},"factory_estimated_delivery_at":{"description":"Factory Estimated Delivery At.","format":"date-time","nullable":true,"type":"string"},"delivery_note":{"description":"Delivery Note.","nullable":true,"type":"string"},"factory_delivery_lead_time":{"description":"Factory delivery Lead Time in Days.","nullable":true,"type":"integer"},"adjusted_factory_delivery_lead_time":{"description":"Adjusted factory delivery lead time in days.","nullable":true,"type":"integer"},"product_code":{"description":"Code (SKU) of the product. As an alternative, you can also use product_id","type":"string"},"assessment_sotd":{"description":"SOTD (Supplier On-time Delivery)","nullable":true,"type":"string"},"planning_request_shipping_at":{"description":"Request Shipping At.","format":"date-time","nullable":true,"type":"string"},"order_adjusted_modal_type":{"description":"Order Adjusted Modal Type.","nullable":true,"type":"string"},"order_request_number":{"description":"Order Request Number.","nullable":true,"type":"string"},"concession_act":{"description":"Concession Act.","nullable":true,"type":"string"},"customs_estimated_release_at":{"description":"Customs estimated date of release.","format":"date-time","nullable":true,"type":"string"},"purchase_country_code":{"description":"Purchase Country Code.","nullable":true,"type":"string"},"quotation_opening_date":{"description":"Quotation Opening Date.","format":"date","nullable":true,"type":"string"},"adjusted_customs_release_lead_time":{"description":"Adjusted customs release lead time in days.","nullable":true,"type":"integer"},"measurement_unit_sap":{"description":"Measurement unit from SAP.","nullable":true,"type":"string"},"shipment_transport_lead_time":{"description":"Shipment transport Lead Time in Days.","nullable":true,"type":"integer"},"id":{"description":"Unique identifier for the POI.","type":"integer"},"order_requested_at":{"description":"Order requested at (PO Operador)","format":"date-time","nullable":true,"type":"string"},"delivery_note_issued_at":{"description":"Delivery Note Issued At.","format":"date","nullable":true,"type":"string"},"gross_weight_kg":{"description":"Gross weight in kilograms.","format":"number","nullable":true,"type":"string"},"supplier_ready_lead_time_days":{"description":"Supplier Readiness Lead Time Days.","nullable":true,"type":"integer"},"quantity":{"description":"The quantity of products associated with this POI.","format":"number","nullable":true,"type":"string"},"invoice_issued_at":{"description":"Invoice Issued At.","format":"date","nullable":true,"type":"string"},"shipment_planned_arrival_at":{"description":"Shipment Planned Arrival At.","format":"date-time","nullable":true,"type":"string"},"supplier_estimated_ready_at":{"description":"Supplier Estimated Readiness At.","format":"date-time","nullable":true,"type":"string"},"order_currency_code":{"description":"Order Currency Code.","nullable":true,"type":"string"},"invoice_value":{"description":"Invoice Value.","format":"number","nullable":true,"type":"string"},"customs_register_lead_time":{"description":"Customs DI registration Lead Time in Days.","nullable":true,"type":"integer"},"adjusted_shipment_transport_lead_time":{"description":"Adjusted shipment transport lead time in days.","nullable":true,"type":"integer"},"planning_shipping_at":{"description":"Shipping At.","format":"date-time","nullable":true,"type":"string"},"invoice_number":{"description":"Invoice Number.","nullable":true,"type":"string"},"adjusted_customs_register_lead_time":{"description":"Adjusted customs register lead time in days.","nullable":true,"type":"integer"},"customs_estimated_register_at":{"description":"Customs estimated date of DI registration.","format":"date-time","nullable":true,"type":"string"},"shipment_containers_quantity":{"description":"Shipment Containers Quantity.","format":"number","nullable":true,"type":"string"},"product_id":{"description":"Unique identifier for the Product. As an alternative, you can also use product_code","type":"integer"},"supplier_sent_at":{"description":"Supplier Sent At.","format":"date-time","nullable":true,"type":"string"},"supplier_ready_at":{"description":"Supplier Readiness At.","format":"date-time","nullable":true,"type":"string"},"dispatching_country_code":{"description":"Dispatching Country Code.","nullable":true,"type":"string"},"factory_delivery_at":{"description":"Factory Delivery At.","format":"date-time","nullable":true,"type":"string"},"factory_planned_delivery_at":{"description":"Factory Planned Delivery At.","format":"date-time","nullable":true,"type":"string"},"item_foreign_operators":{"description":"Unique identifiers for the Foreign Operator.","items":{"type":"integer"},"nullable":true,"type":"array"},"invoice_type":{"description":"Invoice type.","nullable":true,"type":"string"},"adjusted_shipment_boarding_lead_time":{"description":"Adjusted shipment boarding lead time in days.","nullable":true,"type":"integer"},"item_status":{"description":"Item Status","nullable":true,"type":"string"},"adjusted_supplier_ready_lead_time_days":{"description":"Adjusted supplier ready lead time in days.","nullable":true,"type":"integer"},"supplier_planned_ready_at":{"description":"Supplier Planned Readiness At.","format":"date-time","nullable":true,"type":"string"},"supplier_calculated_ready_at":{"description":"Supplier Calculated Readiness At.","format":"date-time","nullable":true,"type":"string"},"cubage_cubic_meters":{"description":"Cubage in cubic meters.","format":"number","nullable":true,"type":"string"}},"required":["line_reference"],"title":"NestedUpdatePurchaseOrderItemParams","type":"object"},"UpsertCostPerExpenseParams":{"description":"Available parameters to upsert Cost Per Expens in batch.","properties":{"params":{"items":{"description":"Available parameters to upsert a Order.","properties":{"cost":{"description":"Cost value.","format":"decimal","nullable":true,"type":"string"},"cost_model_expense_id":{"description":"Cost Model Expense identifier.","type":"integer"},"planned_cost":{"description":"Planned Cost value.","format":"decimal","nullable":true,"type":"string"}},"required":["cost_model_expense_id","cost"],"type":"object"},"type":"array"}},"title":"UpsertCostPerExpenseParams","type":"object"},"NestedUpdateSalesOrderParams":{"description":"Available parameters to update a Sales Order (SO).","example":{"items":[{"cubage_cubic_meters":null,"dispatch_number":null,"factory_delivery_at":null,"factory_estimated_delivery_at":null,"gross_weight_kg":null,"id":1,"item_status":null,"line_number":1,"line_reference":"1.1","measurement_unit_sap":null,"necessity_type":null,"net_weight_kg":null,"order_currency_code":"USD","order_item_reference":null,"order_request_number":null,"order_unit_value":null,"order_value":null,"product_code":"PRD-123","product_id":1,"quantity":"20.0","shipment_containers_quantity":null,"shipment_equipment_type":null,"shipment_planned_arrival_at":null,"shipment_planned_boarding_at":null,"supplier_estimated_ready_at":null,"supplier_planned_ready_at":null,"supplier_ready_at":null,"ubc":null}],"order_confirmed_at":"2023-10-29T00:00:00Z","order_received_at":"2023-10-29T00:00:00Z","type":"INDIRECT"},"properties":{"items":{"items":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateSalesOrderItemParams"},"description":"Details of the Items associated with this SO."},"type":"array"},"order_confirmed_at":{"description":"Timestamp indicating when the order was confirmed.","format":"date-time","nullable":true,"type":"string"},"order_received_at":{"description":"Timestamp indicating when the order was received.","format":"date-time","nullable":true,"type":"string"},"type":{"description":"Type indicating the type of acquisition of the SO.","enum":["DIRECT","INDIRECT"],"type":"string"}},"title":"NestedUpdateSalesOrderParams","type":"object"},"PurchaseOrderItem":{"description":"This schema defines a 'Purchase Order Item' (POI) data structure.","example":{"net_weight_kg":null,"order_value":null,"shipment_estimated_boarding_at":null,"supplier_confirmation_at":null,"shipment_boarding_lead_time":null,"order_currency":{"code":"USD","name":"US Dollar"},"line_number":1,"line_reference":"1.1","customs_release_lead_time":null,"order_unit_value":null,"shipment_estimated_arrival_at":null,"import_type_sap":null,"manufacturing_country":{"code":"BR","name":"Brazil"},"shipment_planned_boarding_at":null,"sap_by_factor":null,"order_modal_type_sap":null,"shipping_details_delivery_date":null,"shipment_equipment_type":null,"order_item_reference":null,"dispatching_country":{"code":"BR","name":"Brazil"},"factory_estimated_delivery_at":null,"delivery_note":null,"factory_delivery_lead_time":null,"adjusted_factory_delivery_lead_time":null,"assessment_sotd":null,"planning_request_shipping_at":null,"order_adjusted_modal_type":null,"order_request_number":null,"concession_act":null,"customs_estimated_release_at":null,"quotation_opening_date":null,"adjusted_customs_release_lead_time":null,"measurement_unit_sap":null,"shipment_transport_lead_time":null,"id":123,"order_requested_at":null,"delivery_note_issued_at":null,"gross_weight_kg":null,"purchase_country":{"code":"BR","name":"Brazil"},"supplier_ready_lead_time_days":null,"quantity":"20.0","invoice_issued_at":null,"shipment_planned_arrival_at":null,"product_description":"Descrição Produto","supplier_estimated_ready_at":null,"invoice_value":null,"product_mercosul_code":"8708.80.00","customs_register_lead_time":null,"adjusted_shipment_transport_lead_time":null,"planning_shipping_at":null,"balance":"10.0","invoice_number":null,"adjusted_customs_register_lead_time":null,"customs_estimated_register_at":null,"balance_shipped":"10.0","order_total_value":null,"shipment_containers_quantity":null,"supplier_sent_at":null,"supplier_ready_at":null,"factory_delivery_at":null,"factory_planned_delivery_at":null,"invoice_type":null,"adjusted_shipment_boarding_lead_time":null,"item_status":null,"product":{"code":"REF1234","description":"Descrição Produto","id":2,"mercosul_code":"8708.80.00","package_type":"BOTTLES"},"adjusted_supplier_ready_lead_time_days":null,"supplier_planned_ready_at":null,"supplier_calculated_ready_at":null,"cubage_cubic_meters":null},"properties":{"net_weight_kg":{"description":"Net weight in kilograms.","format":"number","nullable":true,"type":"string"},"order_value":{"description":"Order Value.","format":"number","nullable":true,"type":"string"},"shipment_estimated_boarding_at":{"description":"Shipment Estimated Boarding At.","format":"date-time","nullable":true,"type":"string"},"supplier_confirmation_at":{"description":"Supplier Confirmation At.","format":"date-time","nullable":true,"type":"string"},"shipment_boarding_lead_time":{"description":"Shipment boarding Lead Time in Days.","nullable":true,"type":"integer"},"order_currency":{"additionalProperties":{"$ref":"#/components/schemas/Currency"},"description":"Information about the currency used for the Invoice."},"line_number":{"description":"The line number associated with this POI.","nullable":true,"type":"integer"},"line_reference":{"description":"The line reference associated with this POI.","type":"string"},"customs_release_lead_time":{"description":"Customs release Lead Time in Days.","nullable":true,"type":"integer"},"order_unit_value":{"description":"Order Unit Value.","format":"number","nullable":true,"type":"string"},"shipment_estimated_arrival_at":{"description":"Shipment Estimated Arrival At.","format":"date-time","nullable":true,"type":"string"},"import_type_sap":{"description":"Import type from SAP.","nullable":true,"type":"string"},"division":{"description":"Item Division","nullable":true,"type":"string"},"manufacturing_country":{"additionalProperties":{"$ref":"#/components/schemas/Country"},"description":"Manufacturing Country.","nullable":true},"shipment_planned_boarding_at":{"description":"Shipment Planned Boarding At.","format":"date-time","nullable":true,"type":"string"},"sap_by_factor":{"description":"POR factor from SAP.","format":"number","nullable":true,"type":"string"},"order_modal_type_sap":{"description":"Order Modal Type from SAP.","nullable":true,"type":"string"},"shipping_details_delivery_date":{"description":"Shipping Details Delivery Date.","format":"date","nullable":true,"type":"string"},"shipment_equipment_type":{"description":"Shipment Equipment Type.","nullable":true,"type":"string"},"order_item_reference":{"description":"Order Item Reference.","nullable":true,"type":"string"},"dispatching_country":{"additionalProperties":{"$ref":"#/components/schemas/Country"},"description":"Dispatching Country.","nullable":true},"factory_estimated_delivery_at":{"description":"Factory Estimated Delivery At.","format":"date-time","nullable":true,"type":"string"},"delivery_note":{"description":"Delivery Note.","nullable":true,"type":"string"},"factory_delivery_lead_time":{"description":"Factory delivery Lead Time in Days.","nullable":true,"type":"integer"},"adjusted_factory_delivery_lead_time":{"description":"Adjusted factory delivery lead time in days.","nullable":true,"type":"integer"},"assessment_sotd":{"description":"SOTD (Supplier On-time Delivery)","nullable":true,"type":"string"},"planning_request_shipping_at":{"description":"Request Shipping At.","format":"date-time","nullable":true,"type":"string"},"order_adjusted_modal_type":{"description":"Order Adjusted Modal Type.","nullable":true,"type":"string"},"order_request_number":{"description":"Order Request Number.","nullable":true,"type":"string"},"concession_act":{"description":"Concession Act.","nullable":true,"type":"string"},"customs_estimated_release_at":{"description":"Customs estimated date of release.","format":"date-time","nullable":true,"type":"string"},"quotation_opening_date":{"description":"Quotation Opening Date.","format":"date","nullable":true,"type":"string"},"adjusted_customs_release_lead_time":{"description":"Adjusted customs release lead time in days.","nullable":true,"type":"integer"},"measurement_unit_sap":{"description":"Measurement unit from SAP.","nullable":true,"type":"string"},"shipment_transport_lead_time":{"description":"Shipment transport Lead Time in Days.","nullable":true,"type":"integer"},"id":{"description":"Unique identifier for the POI.","type":"integer"},"order_requested_at":{"description":"Order requested at (PO Operador)","format":"date-time","nullable":true,"type":"string"},"delivery_note_issued_at":{"description":"Delivery Note Issued At.","format":"date","nullable":true,"type":"string"},"product_translated_descriptions":{"description":"Copy of Translated descriptions related to the product.","nullable":true,"type":"json"},"gross_weight_kg":{"description":"Gross weight in kilograms.","format":"number","nullable":true,"type":"string"},"purchase_country":{"additionalProperties":{"$ref":"#/components/schemas/Country"},"description":"Purchase Country.","nullable":true},"supplier_ready_lead_time_days":{"description":"Supplier Readiness Lead Time Days.","nullable":true,"type":"integer"},"quantity":{"description":"The quantity of products associated with this POI.","format":"number","nullable":true,"type":"string"},"invoice_issued_at":{"description":"Invoice Issued At.","format":"date","nullable":true,"type":"string"},"shipment_planned_arrival_at":{"description":"Shipment Planned Arrival At.","format":"date-time","nullable":true,"type":"string"},"product_description":{"description":"Copy of Description of the product.","type":"string"},"supplier_estimated_ready_at":{"description":"Supplier Estimated Readiness At.","format":"date-time","nullable":true,"type":"string"},"invoice_value":{"description":"Invoice Value.","format":"number","nullable":true,"type":"string"},"product_mercosul_code":{"description":"Copy of Mercosul Code (NCM) of the product.","nullable":true,"type":"string"},"customs_register_lead_time":{"description":"Customs DI registration Lead Time in Days.","nullable":true,"type":"integer"},"adjusted_shipment_transport_lead_time":{"description":"Adjusted shipment transport lead time in days.","nullable":true,"type":"integer"},"planning_shipping_at":{"description":"Shipping At.","format":"date-time","nullable":true,"type":"string"},"balance":{"description":"The remaining balance of products to be shipped for this POI.","format":"number","nullable":true,"type":"string"},"invoice_number":{"description":"Invoice Number.","nullable":true,"type":"string"},"adjusted_customs_register_lead_time":{"description":"Adjusted customs register lead time in days.","nullable":true,"type":"integer"},"customs_estimated_register_at":{"description":"Customs estimated date of DI registration.","format":"date-time","nullable":true,"type":"string"},"balance_shipped":{"description":"The balance of products shipped for this POI.","format":"number","nullable":true,"type":"string"},"order_total_value":{"description":"Order Total Value.","format":"number","nullable":true,"type":"string"},"shipment_containers_quantity":{"description":"Shipment Containers Quantity.","format":"number","nullable":true,"type":"string"},"supplier_sent_at":{"description":"Supplier Sent At.","format":"date-time","nullable":true,"type":"string"},"supplier_ready_at":{"description":"Supplier Readiness At.","format":"date-time","nullable":true,"type":"string"},"factory_delivery_at":{"description":"Factory Delivery At.","format":"date-time","nullable":true,"type":"string"},"factory_planned_delivery_at":{"description":"Factory Planned Delivery At.","format":"date-time","nullable":true,"type":"string"},"invoice_type":{"description":"Invoice type.","nullable":true,"type":"string"},"adjusted_shipment_boarding_lead_time":{"description":"Adjusted shipment boarding lead time in days.","nullable":true,"type":"integer"},"item_status":{"description":"Item Status","nullable":true,"type":"string"},"product":{"description":"The product linked to this Purchase Order Item","properties":{"code":{"description":"SKU of the product.","type":"string"},"description":{"deprecated":true,"description":"Description of the product. (Deprecated - Use product_description)","type":"string"},"id":{"description":"Unique identifier for the Product.","type":"integer"},"mercosul_code":{"deprecated":true,"description":"Mercosul Code (NCM) of the product. (Deprecated - Use product_mercosul_code)","nullable":true,"type":"string"},"package_type":{"description":"Package Type of the product.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"}},"required":["id","code"],"type":"object"},"adjusted_supplier_ready_lead_time_days":{"description":"Adjusted supplier ready lead time in days.","nullable":true,"type":"integer"},"supplier_planned_ready_at":{"description":"Supplier Planned Readiness At.","format":"date-time","nullable":true,"type":"string"},"supplier_calculated_ready_at":{"description":"Supplier Calculated Readiness At.","format":"date-time","nullable":true,"type":"string"},"cubage_cubic_meters":{"description":"Cubage in cubic meters.","format":"number","nullable":true,"type":"string"}},"required":["id","product","line_reference"],"title":"PurchaseOrderItem","type":"object"},"VesselWithDimensions":{"description":"This schema defines a 'Vessel' data structure containing dimensions and static data.","example":{"ais_class":"A","callsign":"VROL8","country":{"code":"US","iso3":"USA","name":"United States"},"deadweight":500,"dimensions":{"a":124,"b":176,"c":15,"d":33,"length":272,"width":40},"gross_tonnage":300,"id":123,"imo_number":"9743265","mmsi_number":"538006242","name":"NEW ORLEANS","ship_sub_type":"AGGREGATES_CARRIER","ship_type":"ANTI_POLLUTION"},"properties":{"ais_class":{"description":"The class of the Vessel's Automatic Identification System (AIS).","enum":["A","B"],"nullable":true,"type":"string"},"callsign":{"description":"The radio callsign used to identify the Vessel.","nullable":true,"type":"string"},"country":{"additionalProperties":{"$ref":"#/components/schemas/Country"},"description":"Country of the Vessel flag.","nullable":true},"deadweight":{"description":"Deadweight tonnage (DWT) of the vessel.","nullable":true,"type":"integer"},"dimensions":{"nullable":true,"properties":{"a":{"description":"Dimension A of the vessel.","type":"integer"},"b":{"description":"Dimension B of the vessel.","type":"integer"},"c":{"description":"Dimension C of the vessel.","type":"integer"},"d":{"description":"Dimension D of the vessel.","type":"integer"},"length":{"description":"Length of the vessel.","type":"integer"},"width":{"description":"Width of the vessel.","type":"integer"}},"type":"object"},"gross_tonnage":{"description":"Gross tonnage (GT) of the vessel.","nullable":true,"type":"integer"},"id":{"description":"The unique identifier for the Vessel.","type":"integer"},"imo_number":{"description":"The International Maritime Organization (IMO) number for the Vessel.","nullable":true,"type":"string"},"mmsi_number":{"description":"The Maritime Mobile Service Identity (MMSI) number for the Vessel.","nullable":true,"type":"string"},"name":{"description":"The name of the Vessel.","type":"string"},"ship_sub_type":{"description":"The sub-type of the Vessel.","enum":["AGGREGATES_CARRIER","ALUMINIUM_CARRIER","BITUMEN_CARRIER","CABU_CARRIER","CAR_CARRIER","CARBON_DIOXIDE","CEMENT_CARRIER","COAL","COMBINATION_CARRIER","CONTAINER","CONTAINER_BULK","CONTAINER_REEFER","DECK_CARGO","DRY_BULK","EFFLUENT_TANKER","FISH_CARRIER","FISHING","GENERAL_TANKER","GREAT_LAKES","GYPSUM_CARRIER","HEAVY_LIFT","HEAVY_LIFT_SEMI_SUBMERSIBLE","LIMESTONE_CARRIER","LIVESTOCK","LNG_CARRIER","LOG_CARRIER","LOGS","LPG_CARRIER","LUMBER_CARRIER","MISCELLANEOUS","MOLASSES_CARRIER","MULTI_PURPOSE_CARRIER","NUCLEAR_FUEL_CARRIER","OFFSHORE","OPEN_HATCH","ORE_BULK_OIL_CARRIER","ORE_CARRIER","ORE_OIL_CARRIER","OTHER","PALLET_CARRIER","PROBO","REEFER","REPLENISHMENT","ROLL_ON_ROLL_OFF","SEA_RIVER_TYPE","SELF_DISCHARGING","SLOPS","STONE_CARRIER","TANKER_CHEMICALS","TANKER_CRUDE","TANKER_PRODUCT","TUG","TWEEN_DECKER","VEG_OIL_CARRIER","VEHICLE_PASSENGER","WATER_CARRIER","WINE_CARRIER","WOOD_CHIP_CARRIER","WOOD_PULP"],"nullable":true,"type":"string"},"ship_type":{"description":"The type of the Vessel.","enum":["ANTI_POLLUTION","CAR_CARRIER","COMBINATION_CARRIER","CONTAINER","DIVE_VESSEL","DREDGER","DRY_BULK","FISHING","GAS_CARRIER","GENERAL_CARGO","GENERAL_TANKER","HIGH_SPEED_CRAFT","LAW_ENFORCEMENT","LIVESTOCK","LNG_CARRIER","MEDICAL_TRANS","MILITARY_OPS","OFFSHORE","OTHER","PASSENGER","PILOT_VESSEL","PLEASURE_CRAFT","PORT_TENDER","REEFER","ROLL_ON_ROLL_OFF","SAILING","SEARCH_AND_RESCUE","SPECIAL_CRAFT","TANKER_CHEMICALS","TANKER_CRUDE","TANKER_PRODUCT","TUG","VEHICLE_PASSENGER"],"nullable":true,"type":"string"}},"required":["id","name"],"title":"VesselWithDimensions","type":"object"},"DuimpParams":{"description":"Available parameters to create or update an DUIMP.","example":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","last_updated_at":"2023-11-04T14:30:00Z","number":"21BR00000012345","registered_at":"2023-11-04T10:00:00Z","status":"ADVANCE_DELIVERY_AWAITING_CARGO_DELIVERY","version":1},"properties":{"channel":{"description":"The DUIMP channel.","enum":["GREEN","RED","YELLOW","GRAY"],"nullable":true,"type":"string"},"customs_cleared_at":{"description":"The timestamp when the DUIMP was customs cleared.","format":"date-time","nullable":true,"type":"string"},"delivered_at":{"description":"The timestamp when the DUIMP was endorsed.","format":"date-time","nullable":true,"type":"string"},"extra":{"description":"Additional information related to the DUIMP.","nullable":true,"type":"object"},"last_updated_at":{"description":"The timestamp when the DUIMP was last updated.","format":"date-time","nullable":true,"type":"string"},"number":{"description":"The DUIMP number.","type":"string"},"registered_at":{"description":"The timestamp when the DUIMP was registered.","format":"date-time","nullable":true,"type":"string"},"status":{"description":"The current status of the DUIMP.","enum":["ADVANCE_DELIVERY_AWAITING_CARGO_DELIVERY","ADVANCE_DELIVERY_AWAITING_STATE_TAX_PENDING","ADVANCE_DELIVERY_CARGO_DELIVERED","CANCELED_BY_CUSTOMS","CANCELED_BY_VERIFICATION","CLEARED_AWAITING_CARGO_DELIVERY","CLEARED_AWAITING_STATE_TAX_PENDING","CLEARED_CARGO_DELIVERED","REGISTERED_AWAITING_CHANNEL","SELECTED_FOR_INSPECTION"],"nullable":true,"type":"string"},"status_response":{"description":"The response status for the DUIMP.","enum":["PENDING","NOT_FOUND","FOUND","INVALID"],"nullable":true,"type":"string"},"version":{"description":"The DUIMP version.","type":"integer"}},"title":"DuimpParams","type":"object"},"HawbShipmentData":{"description":"This schema defines a 'HawbShipmentData' data structure.","example":{"airline":{"callsign":"AMERICAN","hub_code":"DFW","iata_code":"AA","icao_code":"AAL","id":1,"name":"American Airlines"},"arrival_place_dta":"Warehouse B","ata":"2023-04-02T14:30:00Z","ata_dta":"2023-04-03T11:00:00Z","atd":"2023-04-01T10:15:00Z","atd_dta":"2023-04-03T09:00:00Z","departure_place_dta":"Airport A","di_number":"DI987654","dta_number":"DTA123456","eta":"2023-04-02T14:00:00Z","etd":"2023-04-01T10:00:00Z","extra":{},"flight":"AA123","hawb":"123-45678901","id":1,"loading_airport":{"city_iata_code":"SAO","iata_code":"GRU","icao_code":"SBGR","id":2736,"latitude":-22.816668,"longitude":-45.216667,"name":"Aeroporto Internacional Guarulhos","timezone":"America/Sao_Paulo"},"status":"In Transit","stopovers":1,"unloading_airport":{"city_iata_code":"SAO","iata_code":"GRU","icao_code":"SBGR","id":2736,"latitude":-22.816668,"longitude":-45.216667,"name":"Aeroporto Internacional Guarulhos","timezone":"America/Sao_Paulo"},"vehicle_plate_dta":"ABC1234"},"properties":{"airline":{"description":"The airline associated with the shipment.","properties":{"callsign":{"description":"The radio callsign, a unique identifier used in air traffic control communications.","nullable":true,"type":"string"},"hub_code":{"description":"The hub code of the airline's primary operational hub, indicating the central Airport.","nullable":true,"type":"string"},"iata_code":{"description":"The IATA (International Air Transport Association) code.","nullable":true,"type":"string"},"icao_code":{"description":"The ICAO (International Civil Aviation Organization) code.","nullable":true,"type":"string"},"id":{"description":"The unique identifier for the Airline.","type":"integer"},"name":{"description":"The name of the Airline.","type":"string"}},"type":"object"},"arrival_place_dta":{"description":"Arrival place for DTA.","type":"string"},"ata":{"description":"Actual Time of Arrival.","format":"date-time","type":"string"},"ata_dta":{"description":"Actual Time of Arrival for DTA.","format":"date-time","type":"string"},"atd":{"description":"Actual Time of Departure.","format":"date-time","type":"string"},"atd_dta":{"description":"Actual Time of Departure for DTA.","format":"date-time","type":"string"},"departure_place_dta":{"description":"Departure place for DTA.","type":"string"},"di_number":{"description":"The DI number.","type":"string"},"dta_number":{"description":"The DTA number.","type":"string"},"eta":{"description":"Estimated Time of Arrival.","format":"date-time","type":"string"},"etd":{"description":"Estimated Time of Departure.","format":"date-time","type":"string"},"extra":{"description":"Additional information.","type":"object"},"flight":{"description":"The flight number.","type":"string"},"hawb":{"description":"The HAWB number.","nullable":false,"type":"string"},"id":{"description":"The unique identifier for the HAWB Shipment Data.","nullable":false,"type":"integer"},"loading_airport":{"description":"The loading airport.","properties":{"city_iata_code":{"description":"The IATA code for the city where the Airport is located.","nullable":true,"type":"string"},"country":{"additionalProperties":{"$ref":"#/components/schemas/Country"},"description":"The Country where the Airport is located.","nullable":true},"iata_code":{"description":"The IATA (International Air Transport Association) code for the Airport.","type":"string"},"icao_code":{"description":"The ICAO (International Civil Aviation Organization) code for the Airport.","nullable":true,"type":"string"},"id":{"description":"The unique identifier for the Airport.","type":"integer"},"latitude":{"description":"The latitude coordinates of the Airport.","nullable":true,"type":"string"},"longitude":{"description":"The longitude coordinates of the Airport.","nullable":true,"type":"string"},"name":{"description":"The name of the Airport.","type":"string"},"timezone":{"description":"The timezone in which the Airport is located.","nullable":true,"type":"string"}},"type":"object"},"status":{"description":"The status of the shipment.","type":"string"},"stopovers":{"description":"The number of stopovers.","type":"integer"},"unloading_airport":{"description":"The unloading airport.","properties":{"city_iata_code":{"description":"The IATA code for the city where the Airport is located.","nullable":true,"type":"string"},"country":{"additionalProperties":{"$ref":"#/components/schemas/Country"},"description":"The Country where the Airport is located.","nullable":true},"iata_code":{"description":"The IATA (International Air Transport Association) code for the Airport.","type":"string"},"icao_code":{"description":"The ICAO (International Civil Aviation Organization) code for the Airport.","nullable":true,"type":"string"},"id":{"description":"The unique identifier for the Airport.","type":"integer"},"latitude":{"description":"The latitude coordinates of the Airport.","nullable":true,"type":"string"},"longitude":{"description":"The longitude coordinates of the Airport.","nullable":true,"type":"string"},"name":{"description":"The name of the Airport.","type":"string"},"timezone":{"description":"The timezone in which the Airport is located.","nullable":true,"type":"string"}},"type":"object"},"vehicle_plate_dta":{"description":"The vehicle plate for DTA.","type":"string"}},"required":["id","hawb"],"title":"HawbShipmentData","type":"object"},"ActorsResponse":{"description":"An array containing details of multiple actors.","properties":{"data":{"items":{"$ref":"#/components/schemas/Actor"},"type":"array"}},"title":"ActorsResponse","type":"object"},"CostModelVersionFullObject":{"description":"This schema defines an 'Cost Model Version' data structure.","example":{"cost_model":{"currency":{"code":"USD","name":"US Dollar","symbol":"$"},"has_cost_per_product":false,"has_planned_costs":false,"id":123,"name":"Cost Model"},"id":123,"root_model_expenses":[],"version":1},"properties":{"cost_model":{"additionalProperties":{"$ref":"#/components/schemas/CostModelFullObject"},"description":"A Cost Model associated with this Cost Model Version.","nullable":false},"id":{"description":"Unique identifier for the Cost Model Version.","type":"integer"},"root_model_expenses":{"items":{"additionalProperties":{"$ref":"#/components/schemas/CostModelExpense"},"properties":{"children_model_expenses":{"items":{"additionalProperties":{"$ref":"#/components/schemas/CostModelExpense"},"properties":{"children_model_expenses":{"items":{"additionalProperties":{"$ref":"#/components/schemas/CostModelExpense"},"type":"object"},"nullable":true,"type":"array"}},"type":"object"},"nullable":true,"type":"array"}},"type":"object"},"nullable":true,"type":"array"},"version":{"description":"Version the Cost Model.","type":"integer"}},"required":["id","version"],"title":"CostModelVersionFullObject","type":"object"},"NestedUpdateRoadTransportTripPhaseParams":{"description":"Available nested parameters to update a Foreign Trade Road Transport Trip Phase.","example":{"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":123},"properties":{"departure_at":{"description":"The timestamp when the Phase started.","format":"date-time","nullable":true,"type":"string"},"estimated_realized_at":{"description":"The estimated timestamp when the Phase was realized.","format":"date-time","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Road Transport Trip Phase.","type":"integer"},"realized_at":{"description":"The timestamp when the Phase was realized.","format":"date-time","nullable":true,"type":"string"},"route_point_id":{"description":"Unique identifier for the Route Point.","type":"integer"}},"title":"NestedUpdateRoadTransportTripPhaseParams","type":"object"},"RoadTransportTrip":{"description":"This schema defines a 'Road Transport Trip' data structure.","example":{"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"},"properties":{"driver":{"additionalProperties":{"$ref":"#/components/schemas/Driver"},"description":"Information about the associated Driver.","nullable":true},"driver_name":{"description":"The name of the Driver.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Road Transport Trip.","type":"integer"},"phases":{"items":{"additionalProperties":{"$ref":"#/components/schemas/RoadTransportTripPhase"},"description":"Details of different Phases of the Trip."},"type":"array"},"position":{"description":"The position of the Trip in order.","type":"integer"},"trailer":{"additionalProperties":{"$ref":"#/components/schemas/Trailer"},"description":"Information about the associated Trailer.","nullable":true},"trailer_plate":{"description":"The plate of the associated Trailer.","nullable":true,"type":"string"},"transportables":{"items":{"additionalProperties":{"$ref":"#/components/schemas/Transportable"},"description":"Information about the transportable items associated with the Trip."},"type":"array"},"vehicle":{"additionalProperties":{"$ref":"#/components/schemas/Vehicle"},"description":"Information about the associated Vehicle.","nullable":true},"vehicle_plate":{"description":"The plate of the associated Vehicle.","nullable":true,"type":"string"}},"required":["id","position"],"title":"RoadTransportTrip","type":"object"},"Duimp":{"description":"This schema defines a 'DUIMP' data structure.","example":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","id":1,"inserted_at":"2023-11-04T09:30:00Z","last_updated_at":"2023-11-04T14:30:00Z","number":"21BR00000012345","registered_at":"2023-11-04T10:00:00Z","status":"ADVANCE_DELIVERY_AWAITING_CARGO_DELIVERY","status_response":"FOUND","version":1},"properties":{"channel":{"description":"The DUIMP channel.","enum":["GREEN","RED","YELLOW","GRAY"],"nullable":true,"type":"string"},"customs_cleared_at":{"description":"The timestamp when the DUIMP was customs cleared.","format":"date-time","nullable":true,"type":"string"},"delivered_at":{"description":"The timestamp when the DUIMP was endorsed.","format":"date-time","nullable":true,"type":"string"},"extra":{"description":"Additional information related to the DUIMP.","nullable":true,"type":"object"},"id":{"description":"Unique identifier for the DUIMP.","type":"integer"},"importer":{"additionalProperties":{"$ref":"#/components/schemas/Actor"},"description":"The importer"},"inserted_at":{"description":"The timestamp when the DUIMP was inserted.","format":"date-time","type":"string"},"last_updated_at":{"description":"The timestamp when the DUIMP was last updated.","format":"date-time","nullable":true,"type":"string"},"number":{"description":"The DUIMP number.","type":"string"},"registered_at":{"description":"The timestamp when the DUIMP was registered.","format":"date-time","nullable":true,"type":"string"},"status":{"description":"The current status of the DUIMP.","enum":["ADVANCE_DELIVERY_AWAITING_CARGO_DELIVERY","ADVANCE_DELIVERY_AWAITING_STATE_TAX_PENDING","ADVANCE_DELIVERY_CARGO_DELIVERED","CANCELED_BY_CUSTOMS","CANCELED_BY_VERIFICATION","CLEARED_AWAITING_CARGO_DELIVERY","CLEARED_AWAITING_STATE_TAX_PENDING","CLEARED_CARGO_DELIVERED","REGISTERED_AWAITING_CHANNEL","SELECTED_FOR_INSPECTION"],"nullable":true,"type":"string"},"status_response":{"description":"The response status for the DUIMP.","enum":["PENDING","NOT_FOUND","FOUND","INVALID"],"type":"string"},"version":{"description":"The DUIMP version.","type":"integer"}},"required":["id","number","version","status_response","inserted_at"],"title":"Duimp","type":"object"},"CeMercanteDataCargoManifest":{"description":"This schema defines a 'CeMercanteDataCargoManifest' data structure.","example":{"discharge_port_terminal":null,"discharge_port_unlocode":"BRSSZ","loading_port_terminal":null,"loading_port_unlocode":"BRRIO","manifest_number":"1234"},"properties":{"discharge_port_terminal":{"description":"The Discharge Port Terminal of the CE Mercante Cargo Manifest.","type":"string"},"discharge_port_unlocode":{"description":"The Discharge Port Unlocode of the CE Mercante.","type":"string"},"loading_port_terminal":{"description":"The Loading Port Terminal of the CE Mercante Cargo Manifest.","type":"string"},"loading_port_unlocode":{"description":"The Loading Port Unlocode of the CE Mercante.","type":"string"},"manifest_number":{"description":"The Manifest Number of the CE Mercante Cargo Manifest.","type":"string"}},"title":"CeMercanteDataCargoManifest","type":"object"},"Currency":{"description":"This schema defines a 'Currency' data structure.","example":{"code":"USD","name":"US Dollar","symbol":"$"},"properties":{"code":{"description":"The Currency code.","nullable":true,"type":"string"},"name":{"description":"The name of the Currency.","type":"string"},"symbol":{"description":"The Currency symbol.","type":"string"}},"required":["code","name"],"title":"Currency","type":"object"},"VesselWithCurrentVoyageResponse":{"description":"Response containing vessel details with current voyage information.","properties":{"data":{"$ref":"#/components/schemas/VesselWithCurrentVoyage"}},"title":"VesselWithCurrentVoyageResponse","type":"object"},"NestedUpdateTransportableParams":{"description":"Available nested parameters to update a Transportable.","example":{"cargo":null,"container":{"code":"MSDU5953962","cubic_meters":30.0,"demurrage_free_time_start_at":"2023-01-01T00:00:00Z","dispatch_number":"DISP12345","gross_weight_kg":"100.10","hidden":false,"id":1,"invoice_number":"99999","is_stackable":true,"load_type":"GENERAL_CARGO","max_weight_kg":"100.123","observations":"observation example","seal_code":"SEAL_CODE","secondary_seal_code":"SECONDARY_SEAL_CODE","size_foot_type":"20_FOOT","tare_weight_kg":"100","tracking_manual":true,"transport_document":"TDOC67890","type":"DRY"},"id":1},"properties":{"cargo":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateCargoParams"},"description":"Details of the Cargo if the Transportable is of type 'cargo'.","nullable":true},"container":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateContainerParams"},"description":"Details of the Container if the Transportable is of type 'container'.","nullable":true},"id":{"description":"Unique identifier for the Transportable.","type":"integer"}},"title":"NestedUpdateTransportableParams","type":"object"},"AirTransportShipment":{"description":"This schema defines an 'Air Transport Shipment' data structure.","example":{"airline":{"callsign":"AMERICAN","hub_code":"DFW","iata_code":"AA","icao_code":"AAL","id":1,"name":"American Airlines"},"awb":"123-45678901","destination_airport":{"city_iata_code":"AAA","iata_code":"AAA","icao_code":"NTGA","id":1,"latitude":-17.05,"longitude":-145.41667,"name":"Anaa","timezone":"Pacific/Tahiti"},"hawb":"HAWB-123456","id":123,"origin_airport":{"city_iata_code":"SAO","iata_code":"GRU","icao_code":"SBGR","id":2736,"latitude":-22.816668,"longitude":-45.216667,"name":"Aeroporto Internacional Guarulhos","timezone":"America/Sao_Paulo"},"type":"ENVIROTAINER"},"properties":{"airline":{"additionalProperties":{"$ref":"#/components/schemas/Airline"},"description":"Details of the Airline responsible for this Air Transport Shipment.","nullable":true},"awb":{"description":"Air Waybill (AWB) number associated with the Shipment.","nullable":true,"type":"string"},"destination_airport":{"additionalProperties":{"$ref":"#/components/schemas/Airport"},"description":"Details of the destination Airport for this Air Transport Shipment.","nullable":true},"hawb":{"description":"House Air Waybill (HAWB) number associated with the Shipment.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Air Transport Shipment.","type":"integer"},"origin_airport":{"additionalProperties":{"$ref":"#/components/schemas/Airport"},"description":"Details of the origin Airport for this Air Transport Shipment.","nullable":true},"type":{"description":"Type of Shipment.","enum":["ENVIROTAINER","PALLET","LOOSE_CARGO"],"nullable":true,"type":"string"}},"required":["id"],"title":"AirTransportShipment","type":"object"},"DocumentResponse":{"description":"Schema representing the response for a single document. Contains document data.","properties":{"data":{"$ref":"#/components/schemas/Document"}},"title":"DocumentResponse","type":"object"},"ForeignTradeItemShipment":{"description":"This schema defines a 'Foreign Trade Shipment Item' data structure.","example":{"brazilian_invoice_unit_value":"10","cubage_cubic_meters":null,"gross_weight_kg":null,"id":123,"net_weight_kg":"0.5","purchase_order_item":{"net_weight_kg":null,"order_value":null,"shipment_estimated_boarding_at":null,"supplier_confirmation_at":null,"shipment_boarding_lead_time":null,"order_currency":{"code":"USD","name":"US Dollar"},"line_number":1,"line_reference":"1.1","customs_release_lead_time":null,"order_unit_value":null,"shipment_estimated_arrival_at":null,"import_type_sap":null,"manufacturing_country":{"code":"BR","name":"Brazil"},"shipment_planned_boarding_at":null,"sap_by_factor":null,"order_modal_type_sap":null,"shipping_details_delivery_date":null,"shipment_equipment_type":null,"order_item_reference":null,"dispatching_country":{"code":"BR","name":"Brazil"},"factory_estimated_delivery_at":null,"delivery_note":null,"factory_delivery_lead_time":null,"adjusted_factory_delivery_lead_time":null,"assessment_sotd":null,"planning_request_shipping_at":null,"order_adjusted_modal_type":null,"order_request_number":null,"concession_act":null,"customs_estimated_release_at":null,"quotation_opening_date":null,"adjusted_customs_release_lead_time":null,"measurement_unit_sap":null,"shipment_transport_lead_time":null,"id":123,"order_requested_at":null,"delivery_note_issued_at":null,"gross_weight_kg":null,"purchase_country":{"code":"BR","name":"Brazil"},"supplier_ready_lead_time_days":null,"quantity":"20.0","invoice_issued_at":null,"shipment_planned_arrival_at":null,"product_description":"Descrição Produto","supplier_estimated_ready_at":null,"invoice_value":null,"product_mercosul_code":"8708.80.00","customs_register_lead_time":null,"adjusted_shipment_transport_lead_time":null,"planning_shipping_at":null,"balance":"10.0","order":{"id":2,"reference_code":"REF-2"},"invoice_number":null,"adjusted_customs_register_lead_time":null,"customs_estimated_register_at":null,"balance_shipped":"10.0","order_total_value":null,"shipment_containers_quantity":null,"supplier_sent_at":null,"supplier_ready_at":null,"factory_delivery_at":null,"factory_planned_delivery_at":null,"invoice_type":null,"adjusted_shipment_boarding_lead_time":null,"item_status":null,"product":{"code":"REF1234","description":"Descrição Produto","id":2,"mercosul_code":"8708.80.00","package_type":"BOTTLES"},"adjusted_supplier_ready_lead_time_days":null,"supplier_planned_ready_at":null,"supplier_calculated_ready_at":null,"cubage_cubic_meters":null},"quantity":"10","sales_order_item":null,"total_value":"100","unit_value":"10"},"properties":{"brazilian_invoice_unit_value":{"description":"The brazilian invoice unit value of this item in this Shipment.","format":"number","nullable":true,"type":"string"},"cubage_cubic_meters":{"description":"Cubage in cubic meters of this item in this Shipment.","format":"number","nullable":true,"type":"string"},"gross_weight_kg":{"description":"The gross weight in kilograms of this item in this Shipment.","format":"number","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Shipment Item.","type":"integer"},"net_weight_kg":{"description":"The net weight in kilograms of this item in this Shipment.","format":"number","nullable":true,"type":"string"},"purchase_order_item":{"additionalProperties":{"$ref":"#/components/schemas/PurchaseOrderItem"},"description":"Details of the Purchase Order Item associated with this Shipment Item.","properties":{"order":{"properties":{"id":{"description":"Unique identifier for the Order.","type":"integer"},"reference_code":{"description":"A reference code associated with the Order.","type":"string"}},"type":"object"}}},"quantity":{"description":"The number of products in this Shipment that originated from the associated Purchase Order.","format":"number","nullable":true,"type":"string"},"sales_order_item":{"additionalProperties":{"$ref":"#/components/schemas/SalesOrderItem"},"description":"Details of the Sales Order Item associated with this Shipment Item.","properties":{"order":{"properties":{"id":{"description":"Unique identifier for the Order.","type":"integer"},"reference_code":{"description":"A reference code associated with the Order.","type":"string"}},"type":"object"}}},"total_value":{"description":"The total value of this item in this Shipment.","format":"number","nullable":true,"type":"string"},"unit_value":{"description":"The unit value of this item in this Shipment.","format":"number","nullable":true,"type":"string"}},"required":["id"],"title":"ForeignTradeItemShipment","type":"object"},"NestedUpdatePurchaseOrderParams":{"description":"Available parameters to update a Purchase Order (PO).","example":{"items":[{"net_weight_kg":null,"order_value":null,"shipment_estimated_boarding_at":null,"supplier_confirmation_at":null,"shipment_boarding_lead_time":null,"manufacturing_country_code":"BR","line_number":1,"line_reference":"1.1","customs_release_lead_time":null,"order_unit_value":null,"shipment_estimated_arrival_at":null,"import_type_sap":null,"shipment_planned_boarding_at":null,"sap_by_factor":null,"order_modal_type_sap":null,"shipping_details_delivery_date":null,"shipment_equipment_type":null,"order_item_reference":null,"factory_estimated_delivery_at":null,"delivery_note":null,"factory_delivery_lead_time":null,"adjusted_factory_delivery_lead_time":null,"product_code":"PRD-123","assessment_sotd":null,"planning_request_shipping_at":null,"order_adjusted_modal_type":null,"order_request_number":null,"concession_act":null,"customs_estimated_release_at":null,"purchase_country_code":"BR","quotation_opening_date":null,"adjusted_customs_release_lead_time":null,"measurement_unit_sap":null,"shipment_transport_lead_time":null,"id":1,"order_requested_at":null,"delivery_note_issued_at":null,"gross_weight_kg":null,"supplier_ready_lead_time_days":null,"quantity":"20.0","invoice_issued_at":null,"shipment_planned_arrival_at":null,"supplier_estimated_ready_at":null,"order_currency_code":"USD","invoice_value":null,"customs_register_lead_time":null,"adjusted_shipment_transport_lead_time":null,"planning_shipping_at":null,"invoice_number":null,"adjusted_customs_register_lead_time":null,"customs_estimated_register_at":null,"shipment_containers_quantity":null,"product_id":1,"supplier_sent_at":null,"supplier_ready_at":null,"dispatching_country_code":"BR","factory_delivery_at":null,"factory_planned_delivery_at":null,"item_foreign_operators":[],"invoice_type":null,"adjusted_shipment_boarding_lead_time":null,"item_status":null,"adjusted_supplier_ready_lead_time_days":null,"supplier_planned_ready_at":null,"supplier_calculated_ready_at":null,"cubage_cubic_meters":null}],"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"},"properties":{"items":{"items":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdatePurchaseOrderItemParams"},"description":"Details of the Items associated with this PO."},"type":"array"},"necessity_date":{"description":"The timestamp serving as the reference point for the necessity of the PO.","format":"date-time","nullable":true,"type":"string"},"supplier_expected_readiness_at":{"description":"The timestamp serving as the reference point for the supplier's expected readiness of the PO.","format":"date-time","nullable":true,"type":"string"},"supplier_order_accepted_at":{"description":"The timestamp that serves as a reference point for the supplier's acceptance of the PO.","format":"date-time","nullable":true,"type":"string"},"supplier_order_sent_at":{"description":"The timestamp that serves as a reference point for sending the order to the supplier.","format":"date-time","nullable":true,"type":"string"},"supplier_readiness_at":{"description":"The timestamp serving as the reference point for the supplier's availability of the PO.","format":"date-time","nullable":true,"type":"string"},"type":{"description":"Type indicating the type of acquisition of the PO.","enum":["DIRECT","INDIRECT"],"type":"string"}},"title":"NestedUpdatePurchaseOrderParams","type":"object"},"PurchaseOrder":{"description":"This schema defines a 'Purchase Order' (PO) data structure.","example":{"id":123,"items":[{"net_weight_kg":null,"order_value":null,"shipment_estimated_boarding_at":null,"supplier_confirmation_at":null,"shipment_boarding_lead_time":null,"order_currency":{"code":"USD","name":"US Dollar"},"line_number":1,"line_reference":"1.1","customs_release_lead_time":null,"order_unit_value":null,"shipment_estimated_arrival_at":null,"import_type_sap":null,"manufacturing_country":{"code":"BR","name":"Brazil"},"shipment_planned_boarding_at":null,"sap_by_factor":null,"order_modal_type_sap":null,"shipping_details_delivery_date":null,"shipment_equipment_type":null,"order_item_reference":null,"dispatching_country":{"code":"BR","name":"Brazil"},"factory_estimated_delivery_at":null,"delivery_note":null,"factory_delivery_lead_time":null,"adjusted_factory_delivery_lead_time":null,"assessment_sotd":null,"planning_request_shipping_at":null,"order_adjusted_modal_type":null,"order_request_number":null,"concession_act":null,"customs_estimated_release_at":null,"quotation_opening_date":null,"adjusted_customs_release_lead_time":null,"measurement_unit_sap":null,"shipment_transport_lead_time":null,"id":123,"order_requested_at":null,"delivery_note_issued_at":null,"gross_weight_kg":null,"purchase_country":{"code":"BR","name":"Brazil"},"supplier_ready_lead_time_days":null,"quantity":"20.0","invoice_issued_at":null,"shipment_planned_arrival_at":null,"product_description":"Descrição Produto","supplier_estimated_ready_at":null,"invoice_value":null,"product_mercosul_code":"8708.80.00","customs_register_lead_time":null,"adjusted_shipment_transport_lead_time":null,"planning_shipping_at":null,"balance":"10.0","invoice_number":null,"adjusted_customs_register_lead_time":null,"customs_estimated_register_at":null,"balance_shipped":"10.0","order_total_value":null,"shipment_containers_quantity":null,"supplier_sent_at":null,"supplier_ready_at":null,"factory_delivery_at":null,"factory_planned_delivery_at":null,"invoice_type":null,"adjusted_shipment_boarding_lead_time":null,"item_status":null,"product":{"code":"REF1234","description":"Descrição Produto","id":2,"mercosul_code":"8708.80.00","package_type":"BOTTLES"},"adjusted_supplier_ready_lead_time_days":null,"supplier_planned_ready_at":null,"supplier_calculated_ready_at":null,"cubage_cubic_meters":null}],"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"},"properties":{"id":{"description":"Unique identifier for the PO.","type":"integer"},"items":{"items":{"additionalProperties":{"$ref":"#/components/schemas/PurchaseOrderItem"},"description":"Details of the Items associated with this PO."},"type":"array"},"necessity_date":{"description":"The timestamp serving as the reference point for the necessity of the PO.","format":"date-time","nullable":true,"type":"string"},"supplier_expected_readiness_at":{"description":"The timestamp serving as the reference point for the supplier's expected readiness of the PO.","format":"date-time","nullable":true,"type":"string"},"supplier_order_accepted_at":{"description":"The timestamp that serves as a reference point for the supplier's acceptance of the PO.","format":"date-time","nullable":true,"type":"string"},"supplier_order_sent_at":{"description":"The timestamp that serves as a reference point for sending the order to the supplier.","format":"date-time","nullable":true,"type":"string"},"supplier_readiness_at":{"description":"The timestamp serving as the reference point for the supplier's availability of the PO.","format":"date-time","nullable":true,"type":"string"},"type":{"description":"Type indicating the type of acquisition of the PO.","enum":["DIRECT","INDIRECT"],"type":"string"}},"required":["id","type","items"],"title":"PurchaseOrder","type":"object"},"Vessel":{"description":"This schema defines an 'Vessel' data structure.","example":{"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"},"properties":{"ais_class":{"description":"The class of the Vessel's Automatic Identification System (AIS).","enum":["A","B"],"nullable":true,"type":"string"},"callsign":{"description":"The radio callsign used to identify the Vessel.","nullable":true,"type":"string"},"id":{"description":"The unique identifier for the Vessel.","type":"integer"},"imo_number":{"description":"The International Maritime Organization (IMO) number for the Vessel.","nullable":true,"type":"string"},"mmsi_number":{"description":"The Maritime Mobile Service Identity (MMSI) number for the Vessel.","nullable":true,"type":"string"},"name":{"description":"The name of the Vessel.","type":"string"},"ship_sub_type":{"description":"The sub-type of the Vessel.","enum":["AGGREGATES_CARRIER","ALUMINIUM_CARRIER","BITUMEN_CARRIER","CABU_CARRIER","CAR_CARRIER","CARBON_DIOXIDE","CEMENT_CARRIER","COAL","COMBINATION_CARRIER","CONTAINER","CONTAINER_BULK","CONTAINER_REEFER","DECK_CARGO","DRY_BULK","EFFLUENT_TANKER","FISH_CARRIER","FISHING","GENERAL_TANKER","GREAT_LAKES","GYPSUM_CARRIER","HEAVY_LIFT","HEAVY_LIFT_SEMI_SUBMERSIBLE","LIMESTONE_CARRIER","LIVESTOCK","LNG_CARRIER","LOG_CARRIER","LOGS","LPG_CARRIER","LUMBER_CARRIER","MISCELLANEOUS","MOLASSES_CARRIER","MULTI_PURPOSE_CARRIER","NUCLEAR_FUEL_CARRIER","OFFSHORE","OPEN_HATCH","ORE_BULK_OIL_CARRIER","ORE_CARRIER","ORE_OIL_CARRIER","OTHER","PALLET_CARRIER","PROBO","REEFER","REPLENISHMENT","ROLL_ON_ROLL_OFF","SEA_RIVER_TYPE","SELF_DISCHARGING","SLOPS","STONE_CARRIER","TANKER_CHEMICALS","TANKER_CRUDE","TANKER_PRODUCT","TUG","TWEEN_DECKER","VEG_OIL_CARRIER","VEHICLE_PASSENGER","WATER_CARRIER","WINE_CARRIER","WOOD_CHIP_CARRIER","WOOD_PULP"],"nullable":true,"type":"string"},"ship_type":{"description":"The type of the Vessel.","enum":["ANTI_POLLUTION","CAR_CARRIER","COMBINATION_CARRIER","CONTAINER","DIVE_VESSEL","DREDGER","DRY_BULK","FISHING","GAS_CARRIER","GENERAL_CARGO","GENERAL_TANKER","HIGH_SPEED_CRAFT","LAW_ENFORCEMENT","LIVESTOCK","LNG_CARRIER","MEDICAL_TRANS","MILITARY_OPS","OFFSHORE","OTHER","PASSENGER","PILOT_VESSEL","PLEASURE_CRAFT","PORT_TENDER","REEFER","ROLL_ON_ROLL_OFF","SAILING","SEARCH_AND_RESCUE","SPECIAL_CRAFT","TANKER_CHEMICALS","TANKER_CRUDE","TANKER_PRODUCT","TUG","VEHICLE_PASSENGER"],"nullable":true,"type":"string"}},"required":["id","name"],"title":"Vessel","type":"object"},"Cargo":{"description":"This schema defines a 'Cargo' data structure.","example":{"cubic_weight":"200","dimensions":"2 3 4","id":123,"measurement_unit":"KILOGRAMS","quantity":"100","volume_cubic_meters":"10","weight_kg":"100"},"properties":{"cubic_weight":{"description":"The cubic weight of the Cargo.","nullable":true,"type":"string"},"dimensions":{"description":"Dimensions of the Cargo.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Cargo.","type":"integer"},"measurement_unit":{"description":"The unit of measurement used for the Cargo.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"type":"string"},"quantity":{"description":"Quantity of the Cargo.","type":"string"},"volume_cubic_meters":{"description":"Volume of the Cargo in cubic meters.","nullable":true,"type":"string"},"weight_kg":{"description":"Weight of the Cargo linked to the measurement unit.","nullable":true,"type":"string"}},"required":["id","measurement_unit","quantity"],"title":"Cargo","type":"object"},"DefaultResponse":{"description":"This schema defines a 'Default Response' data structure.","properties":{"data":{"properties":{"id":{"description":"Entity ID.","type":"integer"}},"required":["id"],"type":"object"}},"title":"DefaultResponse","type":"object"},"OrderResponse":{"description":"Schema representing the response for a single order. Contains order data.","properties":{"data":{"$ref":"#/components/schemas/Order"}},"title":"OrderResponse","type":"object"},"VesselWithCurrentVoyage":{"description":"This schema defines a 'Vessel' data structure with dimensions, static data and current voyage information.","example":{"ais_class":"A","callsign":"VROL8","country":{"code":"US","iso3":"USA","name":"United States"},"deadweight":500,"dimensions":{"a":124,"b":176,"c":15,"d":33,"length":272,"width":40},"gross_tonnage":300,"id":123,"imo_number":"9743265","last_position_update":{"ais_updated_at":"2024-03-15T10:30:00Z","course":182.3,"heading":180.0,"latitude":-23.9563,"longitude":-46.3292,"speed":12.5,"voyage_destination":"SANTOS","voyage_destination_port_name":"Santos","voyage_destination_port_unlocode":"BRSSZ","voyage_eta":"2024-03-16T08:00:00Z","voyage_updated_at":"2024-03-15T10:30:00Z"},"mmsi_number":"538006242","name":"NEW ORLEANS","ship_sub_type":"CONTAINER","ship_type":"CONTAINER"},"properties":{"ais_class":{"description":"The class of the Vessel's Automatic Identification System (AIS).","enum":["A","B"],"nullable":true,"type":"string"},"callsign":{"description":"The radio callsign used to identify the Vessel.","nullable":true,"type":"string"},"country":{"additionalProperties":{"$ref":"#/components/schemas/Country"},"description":"Country of the Vessel flag.","nullable":true},"deadweight":{"description":"Deadweight tonnage (DWT) of the vessel.","nullable":true,"type":"integer"},"dimensions":{"nullable":true,"properties":{"a":{"description":"Dimension A of the vessel.","type":"integer"},"b":{"description":"Dimension B of the vessel.","type":"integer"},"c":{"description":"Dimension C of the vessel.","type":"integer"},"d":{"description":"Dimension D of the vessel.","type":"integer"},"length":{"description":"Length of the vessel.","type":"integer"},"width":{"description":"Width of the vessel.","type":"integer"}},"type":"object"},"gross_tonnage":{"description":"Gross tonnage (GT) of the vessel.","nullable":true,"type":"integer"},"id":{"description":"The unique identifier for the Vessel.","type":"integer"},"imo_number":{"description":"The International Maritime Organization (IMO) number for the Vessel.","nullable":true,"type":"string"},"last_position_update":{"description":"Current voyage information from the vessel's last position update.","nullable":true,"properties":{"ais_updated_at":{"description":"Timestamp of the last AIS update.","format":"date-time","nullable":true,"type":"string"},"course":{"description":"Course of the vessel in degrees.","format":"float","nullable":true,"type":"number"},"heading":{"description":"Heading of the vessel in degrees.","format":"float","type":"number"},"latitude":{"description":"Latitude of the vessel's last position.","format":"float","type":"number"},"longitude":{"description":"Longitude of the vessel's last position.","format":"float","type":"number"},"speed":{"description":"Speed of the vessel in knots.","format":"float","nullable":true,"type":"number"},"voyage_destination":{"description":"Destination of the current voyage.","nullable":true,"type":"string"},"voyage_destination_port_name":{"description":"Name of the destination port for the current voyage.","nullable":true,"type":"string"},"voyage_destination_port_unlocode":{"description":"UN/LOCODE of the destination port for the current voyage.","nullable":true,"type":"string"},"voyage_eta":{"description":"Estimated Time of Arrival (ETA) for the current voyage.","format":"date-time","nullable":true,"type":"string"},"voyage_updated_at":{"description":"Timestamp when the current voyage information was last updated.","format":"date-time","nullable":true,"type":"string"}},"type":"object"},"mmsi_number":{"description":"The Maritime Mobile Service Identity (MMSI) number for the Vessel.","nullable":true,"type":"string"},"name":{"description":"The name of the Vessel.","type":"string"},"ship_sub_type":{"description":"The sub-type of the Vessel.","enum":["AGGREGATES_CARRIER","ALUMINIUM_CARRIER","BITUMEN_CARRIER","CABU_CARRIER","CAR_CARRIER","CARBON_DIOXIDE","CEMENT_CARRIER","COAL","COMBINATION_CARRIER","CONTAINER","CONTAINER_BULK","CONTAINER_REEFER","DECK_CARGO","DRY_BULK","EFFLUENT_TANKER","FISH_CARRIER","FISHING","GENERAL_TANKER","GREAT_LAKES","GYPSUM_CARRIER","HEAVY_LIFT","HEAVY_LIFT_SEMI_SUBMERSIBLE","LIMESTONE_CARRIER","LIVESTOCK","LNG_CARRIER","LOG_CARRIER","LOGS","LPG_CARRIER","LUMBER_CARRIER","MISCELLANEOUS","MOLASSES_CARRIER","MULTI_PURPOSE_CARRIER","NUCLEAR_FUEL_CARRIER","OFFSHORE","OPEN_HATCH","ORE_BULK_OIL_CARRIER","ORE_CARRIER","ORE_OIL_CARRIER","OTHER","PALLET_CARRIER","PROBO","REEFER","REPLENISHMENT","ROLL_ON_ROLL_OFF","SEA_RIVER_TYPE","SELF_DISCHARGING","SLOPS","STONE_CARRIER","TANKER_CHEMICALS","TANKER_CRUDE","TANKER_PRODUCT","TUG","TWEEN_DECKER","VEG_OIL_CARRIER","VEHICLE_PASSENGER","WATER_CARRIER","WINE_CARRIER","WOOD_CHIP_CARRIER","WOOD_PULP"],"nullable":true,"type":"string"},"ship_type":{"description":"The type of the Vessel.","enum":["ANTI_POLLUTION","CAR_CARRIER","COMBINATION_CARRIER","CONTAINER","DIVE_VESSEL","DREDGER","DRY_BULK","FISHING","GAS_CARRIER","GENERAL_CARGO","GENERAL_TANKER","HIGH_SPEED_CRAFT","LAW_ENFORCEMENT","LIVESTOCK","LNG_CARRIER","MEDICAL_TRANS","MILITARY_OPS","OFFSHORE","OTHER","PASSENGER","PILOT_VESSEL","PLEASURE_CRAFT","PORT_TENDER","REEFER","ROLL_ON_ROLL_OFF","SAILING","SEARCH_AND_RESCUE","SPECIAL_CRAFT","TANKER_CHEMICALS","TANKER_CRUDE","TANKER_PRODUCT","TUG","VEHICLE_PASSENGER"],"nullable":true,"type":"string"}},"required":["id","name"],"title":"VesselWithCurrentVoyage","type":"object"},"NestedCreateForeignTradeShipmentParams":{"description":"Available parameters to create a Foreign Trade Shipment.","example":{"air_transport_shipment":null,"ata":"2023-10-29T00:00:00Z","atd":"2023-10-29T00:00:00Z","automatic_tracking_enabled":true,"ce_mercante_number":null,"cubage_cubic_meters":"1.5","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","empty_return_date":"2023-10-29T00:00:00Z","eta":"2023-10-29T00:00:00Z","etd":"2023-10-29T00:00:00Z","international_freight":{"booking_discharge_airport_id":4,"booking_discharge_port_id":4,"booking_eta":"2023-10-29T00:00:00Z","booking_etd":"2023-10-29T00:00:00Z","booking_loading_airport_id":3,"booking_loading_port_id":3,"cargo_attributes":["REEFER"],"currency_code":"USD","freight_cost_collect":"1250.00","freight_cost_prepaid":"1250.00","freight_cost_road":"1250.00","freight_forwarder":"ABC Shipping","planned_boarding_date":"2023-10-29T00:00:00Z","port_terminal_id":null,"quotation_number":"Q123456","sealine_id":2,"type":"PREPAID","vessel_id":1,"voyage_number":"123A"},"invoices":[{"currency_code":"USD","discount":"10","emitted_at":"2023-11-04T10:00:00Z","incoterm":"CPT","items":[{"batch_number":"BATCH-6789","batch_validity_date":"2024-10-29T00:00:00Z","order_item_line_reference":"1","order_reference_code":"ORC-123","product_description":"Product A","product_sku":"SKU-12345","production_date":"2023-10-29T00:00:00Z","quantity":"5","total_gross_weight_kg":"80.00","unitary_amount":"12.34"}],"number":"INV-2023-001"}],"items":[{"brazilian_invoice_unit_value":"10","cubage_cubic_meters":null,"gross_weight_kg":null,"line_reference":null,"net_weight_kg":"0.5","order_reference_code":null,"purchase_order_item_id":1,"quantity":"10","sales_order_item_id":null,"unit_value":"10"}],"maritime_transport_shipment":{"bl":"MEDUGB760924","booking":null,"discharge_port_id":2,"hbl":null,"loading_port_id":1,"sealine_id":1,"tracking_discharge_port":"BRRIG","tracking_loading_port":"CNNGB","tracking_number":null,"type":"FCL","vessel_id":123,"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":[{"driver_id":123,"driver_name":"John Doe","phases":[{"departure_at":"2023-10-29T00:00:00Z","estimated_realized_at":"2023-10-29T00:00:00Z","realized_at":"2023-10-29T00:00:00Z","route_point_id":1},{"departure_at":"2023-10-29T00:00:00Z","estimated_realized_at":"2023-10-29T00:00:00Z","realized_at":"2023-10-29T00:00:00Z","route_point_id":2}],"position":123,"trailer_plate":"XYZ456","transportable_ids":[123,124],"vehicle_id":123,"vehicle_plate":"ABC123"}]}],"parcel_shipments":[{"ata":null,"atd":"2023-05-15T10:15:00Z","courier_id":1,"destination_address":"Av. B, 456, São Paulo, SP, Brasil","destination_country_code":"BR","eta":"2023-05-20T12:00:00Z","etd":"2023-05-15T10:00:00Z","origin_address":"Rua A, 123, Rio de Janeiro, RJ, Brasil","origin_country_code":"BR","slug":"CourierWidget","tracking_number":"BR1234567890"}],"received_in_warehouse_at":"2023-10-29T00:00:00Z","road_transport_shipment":null,"route_id":1,"shipment_duimps":[{"comments":"Any comments","duimp":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","last_updated_at":"2023-11-04T14:30:00Z","number":"21BR00000012345","registered_at":"2023-11-04T10:00:00Z","status":"ADVANCE_DELIVERY_AWAITING_CARGO_DELIVERY","version":1},"id":1}],"shipment_export_declarations":[{"comments":"Any comments","export_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"},"id":1}],"shipment_import_declarations":[{"comments":"Any 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":"Any 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.5","transportables":[{"cargo":null,"container":{"code":"MSDU5953962","cubic_meters":30.0,"demurrage_free_time_start_at":"2023-01-01T00:00:00Z","dispatch_number":"DISP12345","gross_weight_kg":"100.10","hidden":false,"invoice_number":"99999","is_stackable":true,"load_type":"GENERAL_CARGO","max_weight_kg":"100.123","observations":"observation example","seal_code":"SEAL_CODE","secondary_seal_code":"SECONDARY_SEAL_CODE","size_foot_type":"20_FOOT","tare_weight_kg":"100","tracking_manual":true,"transport_document":"TDOC67890","type":"DRY"}}],"warehouse_free_time_days":1},"properties":{"air_transport_shipment":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateAirTransportShipmentParams"},"description":"Details of Air Transport Shipment if type is 'air_transport'.","nullable":true},"ata":{"description":"ATA (Actual Time of Arrival) for the Shipment.","format":"date-time","nullable":true,"type":"string"},"atd":{"description":"ATD (Actual Time of Departure) for the Shipment.","format":"date-time","nullable":true,"type":"string"},"automatic_tracking_enabled":{"default":true,"description":"Boolean flag indicating if Automatic Tracking is enabled.","type":"boolean"},"ce_mercante_number":{"description":"CE Mercante Number associated with the Shipment.","type":"string"},"cubage_cubic_meters":{"description":"Cubage in cubic meters associated with the Shipment.","format":"decimal","nullable":true,"type":"string"},"delivered_at":{"description":"Date and time when the Shipment was delivered.","format":"date-time","nullable":true,"type":"string"},"demurrage":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateDemurrageParams"},"description":"Details of demurrage associated with this Shipment.","nullable":true},"departed_from_warehouse_at":{"description":"Date and time when the Shipment departed from the warehouse.","format":"date-time","nullable":true,"type":"string"},"empty_return_date":{"description":"Date and time the container returned empty.","format":"date-time","nullable":true,"type":"string"},"eta":{"description":"ETA (Estimated Time of Arrival) for the Shipment.","format":"date-time","nullable":true,"type":"string"},"etd":{"description":"ETD (Estimated Time of Departure) for the Shipment.","format":"date-time","nullable":true,"type":"string"},"international_freight":{"additionalProperties":{"$ref":"#/components/schemas/NestedInternationalFreightParams"},"description":"Details of the International Freight associated with this Shipment."},"invoices":{"description":"A collection of Invoices related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateInvoiceParams"},"description":"Details of the Invoice associated with this Shipment."},"type":"array"},"items":{"description":"A collection of Items related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateForeignTradeItemShipmentParams"},"description":"Details of the Item associated with this Shipment."},"type":"array"},"maritime_transport_shipment":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateMaritimeTransportShipmentParams"},"description":"Details of Maritime Transport Shipment if type is 'maritime_transport'.","nullable":true},"national_road_transports":{"description":"A collection of National Road Transport related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateNationalRoadTransportParams"},"description":"Details of the National Road Transport associated with this Shipment."},"type":"array"},"parcel_shipments":{"description":"A collection of Parcel Shipments related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateParcelShipmentParams"},"description":"Details of the Parcel Shipment associated with this Shipment."},"type":"array"},"received_in_warehouse_at":{"description":"Date and time when the Shipment was received in the warehouse.","format":"date-time","nullable":true,"type":"string"},"road_transport_shipment":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateRoadTransportShipmentParams"},"description":"Details of Road Transport Shipment if type is 'road_transport'.","nullable":true},"route_id":{"description":"Unique identifier for the Route.","nullable":true,"type":"integer"},"shipment_duimps":{"description":"A collection of DUIMP related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedShipmentDuimpParams"},"description":"Details of the DUIMP associated with this Shipment."},"type":"array"},"shipment_export_declarations":{"description":"A collection of Export Declarations related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedShipmentExportDeclarationParams"},"description":"Details of the Export Declarations associated with this Shipment."},"type":"array"},"shipment_import_declarations":{"description":"A collection of Import Declarations related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedShipmentImportDeclarationParams"},"description":"Details of the Import Declarations associated with this Shipment."},"type":"array"},"shipment_import_licenses":{"description":"A collection of Import Licenses related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedShipmentImportLicenseParams"},"description":"Details of the Import Licenses associated with this Shipment."},"type":"array"},"total_gross_weight":{"description":"Total gross weight associated with the Shipment.","format":"decimal","nullable":true,"type":"string"},"total_net_weight":{"description":"Total net weight associated with the Shipment.","format":"decimal","nullable":true,"type":"string"},"transportables":{"description":"A collection of Transportable related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateTransportableParams"},"description":"Details of the Transportable associated with this Shipment."},"type":"array"},"type":{"description":"Type of the Shipment.","enum":["AIR_TRANSPORT","MARITIME_TRANSPORT","ROAD_TRANSPORT"],"nullable":true,"type":"string"},"warehouse_free_time_days":{"description":"Number of days of warehouse free time.","nullable":true,"type":"integer"}},"title":"NestedCreateForeignTradeShipmentParams","type":"object"},"InternationalTransportLeg":{"description":"This schema defines an 'International Transport Leg' data structure.","example":{"arrival_place":"DEHAM","ata":"2024-07-05T21:00:00Z","atd":"2024-06-20T13:00:00Z","departure_place":"SGSIN","eta":"2024-07-05T20:00:00Z","etd":"2024-06-20T12:00:00Z","modal_type":"MARITIME","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":"VY7531"},"properties":{"arrival_place":{"description":"The arrival place of the leg.","nullable":true,"type":"string"},"ata":{"description":"Actual time of arrival (ATA).","format":"date-time","nullable":true,"type":"string"},"atd":{"description":"Actual time of departure (ATD).","format":"date-time","nullable":true,"type":"string"},"departure_place":{"description":"The departure place of the leg.","nullable":true,"type":"string"},"eta":{"description":"Estimated time of arrival (ETA).","format":"date-time","nullable":true,"type":"string"},"etd":{"description":"Estimated time of departure (ETD).","format":"date-time","nullable":true,"type":"string"},"modal_type":{"description":"The type of modal transport.","enum":["MARITIME","ROAD","RAILWAY","INLAND_WATERWAY"],"nullable":true,"type":"string"},"vessel":{"additionalProperties":{"$ref":"#/components/schemas/Vessel"},"description":"Vessel associated with the International Transport Leg.","nullable":true},"voyage":{"description":"The voyage identifier.","nullable":true,"type":"string"}},"title":"InternationalTransportLeg","type":"object"},"NestedUpdateForeignTradeShipmentParams":{"description":"Available parameters to update a Foreign Trade Shipment.","example":{"air_transport_shipment":null,"ata":"2023-10-29T00:00:00Z","atd":"2023-10-29T00:00:00Z","automatic_tracking_enabled":true,"ce_mercante_authorization_status":null,"ce_mercante_number":null,"cubage_cubic_meters":"1.5","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","empty_return_date":"2023-10-29T00:00:00Z","eta":"2023-10-29T00:00:00Z","etd":"2023-10-29T00:00:00Z","international_freight":{"booking_discharge_airport_id":4,"booking_discharge_port_id":4,"booking_eta":"2023-10-29T00:00:00Z","booking_etd":"2023-10-29T00:00:00Z","booking_loading_airport_id":3,"booking_loading_port_id":3,"cargo_attributes":["REEFER"],"currency_code":"USD","freight_cost_collect":"1250.00","freight_cost_prepaid":"1250.00","freight_cost_road":"1250.00","freight_forwarder":"ABC Shipping","planned_boarding_date":"2023-10-29T00:00:00Z","port_terminal_id":null,"quotation_number":"Q123456","sealine_id":2,"type":"PREPAID","vessel_id":1,"voyage_number":"123A"},"invoices":[{"currency_code":"USD","discount":"10","emitted_at":"2023-11-04T10:00:00Z","id":1,"incoterm":"CPT","items":[{"batch_number":"BATCH-6789","batch_validity_date":"2024-10-29T00:00:00Z","id":1,"order_item_line_reference":"1","order_reference_code":"ORC-123","product_description":"Product A","product_sku":"SKU-12345","production_date":"2023-10-29T00:00:00Z","quantity":"5","total_gross_weight_kg":"80.00","unitary_amount":"12.34"}],"number":"INV-2023-001"}],"items":[{"brazilian_invoice_unit_value":"10","cubage_cubic_meters":null,"gross_weight_kg":null,"id":1,"line_reference":null,"net_weight_kg":"0.5","order_reference_code":null,"purchase_order_item_id":1,"quantity":"10","sales_order_item_id":null,"unit_value":"10"}],"maritime_transport_shipment":{"bl":"MEDUGB760924","booking":null,"discharge_port_id":2,"hbl":null,"loading_port_id":1,"sealine_id":1,"tracking_discharge_port":"BRRIG","tracking_loading_port":"CNNGB","tracking_number":null,"type":"FCL","vessel_id":123,"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":123,"transport_completed_at":"2023-10-29T00:00:00Z","transport_features":["REFRIGERATED","HAZARDOUS_PRODUCTS"],"trips":[{"driver_id":123,"driver_name":"John Doe","id":1,"phases":[{"departure_at":"2023-10-29T00:00:00Z","estimated_realized_at":"2023-10-29T00:00:00Z","realized_at":"2023-10-29T00:00:00Z","route_point_id":1},{"departure_at":"2023-10-29T00:00:00Z","estimated_realized_at":"2023-10-29T00:00:00Z","realized_at":"2023-10-29T00:00:00Z","route_point_id":2}],"position":123,"trailer_id":123,"trailer_plate":"XYZ456","transportable_ids":[123,124],"vehicle_id":null,"vehicle_plate":"ABC123"}]}],"parcel_shipments":[{"ata":null,"atd":"2023-05-15T10:15:00Z","courier_id":1,"destination_address":"Av. B, 456, São Paulo, SP, Brasil","destination_country_code":"BR","eta":"2023-05-20T12:00:00Z","etd":"2023-05-15T10:00:00Z","id":1,"origin_address":"Rua A, 123, Rio de Janeiro, RJ, Brasil","origin_country_code":"BR","slug":"CourierWidget","tracking_number":"BR1234567890"}],"received_in_warehouse_at":"2023-10-29T00:00:00Z","road_transport_shipment":null,"route_id":1,"shipment_duimps":[{"comments":"Any comments","duimp":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","last_updated_at":"2023-11-04T14:30:00Z","number":"21BR00000012345","registered_at":"2023-11-04T10:00:00Z","status":"ADVANCE_DELIVERY_AWAITING_CARGO_DELIVERY","version":1},"id":1}],"shipment_export_declarations":[{"comments":"Any comments","export_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"},"id":1}],"shipment_import_declarations":[{"comments":"Any 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":"Any 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.5","transportables":[{"cargo":null,"container":{"code":"MSDU5953962","cubic_meters":30.0,"demurrage_free_time_start_at":"2023-01-01T00:00:00Z","dispatch_number":"DISP12345","gross_weight_kg":"100.10","hidden":false,"id":1,"invoice_number":"99999","is_stackable":true,"load_type":"GENERAL_CARGO","max_weight_kg":"100.123","observations":"observation example","seal_code":"SEAL_CODE","secondary_seal_code":"SECONDARY_SEAL_CODE","size_foot_type":"20_FOOT","tare_weight_kg":"100","tracking_manual":true,"transport_document":"TDOC67890","type":"DRY"},"id":1}],"warehouse_free_time_days":1},"properties":{"air_transport_shipment":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateAirTransportShipmentParams"},"description":"Details of Air Transport Shipment if type is 'air_transport'.","nullable":true},"ata":{"description":"ATA (Actual Time of Arrival) for the Shipment.","format":"date-time","nullable":true,"type":"string"},"atd":{"description":"ATD (Actual Time of Departure) for the Shipment.","format":"date-time","nullable":true,"type":"string"},"automatic_tracking_enabled":{"default":true,"description":"Boolean flag indicating if Automatic Tracking is enabled.","type":"boolean"},"ce_mercante_number":{"description":"CE Mercante Number associated with the Shipment.","type":"string"},"cubage_cubic_meters":{"description":"Cubage in cubic meters associated with the Shipment.","format":"decimal","nullable":true,"type":"string"},"delivered_at":{"description":"Date and time when the Shipment was delivered.","format":"date-time","nullable":true,"type":"string"},"demurrage":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateDemurrageParams"},"description":"Details of demurrage associated with this Shipment.","nullable":true},"departed_from_warehouse_at":{"description":"Date and time when the Shipment departed from the warehouse.","format":"date-time","nullable":true,"type":"string"},"empty_return_date":{"description":"Date and time the container returned empty.","format":"date-time","nullable":true,"type":"string"},"eta":{"description":"ETA (Estimated Time of Arrival) for the Shipment.","format":"date-time","nullable":true,"type":"string"},"etd":{"description":"ETD (Estimated Time of Departure) for the Shipment.","format":"date-time","nullable":true,"type":"string"},"international_freight":{"additionalProperties":{"$ref":"#/components/schemas/NestedInternationalFreightParams"},"description":"Details of the International Freight associated with this Shipment."},"invoices":{"description":"A collection of Invoices related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateInvoiceParams"},"description":"Details of the Invoice associated with this Shipment."},"type":"array"},"items":{"description":"A collection of Items related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateForeignTradeItemShipmentParams"},"description":"Details of the Item associated with this Shipment."},"type":"array"},"maritime_transport_shipment":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateMaritimeTransportShipmentParams"},"description":"Details of Maritime Transport Shipment if type is 'maritime_transport'.","nullable":true},"national_road_transports":{"description":"A collection of National Road Transports related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateNationalRoadTransportParams"},"description":"Details of the National Road Transport associated with this Shipment."},"type":"array"},"parcel_shipments":{"description":"A collection of Parcel Shipments related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateParcelShipmentParams"},"description":"Details of the Parcel Shipment associated with this Shipment."},"type":"array"},"received_in_warehouse_at":{"description":"Date and time when the Shipment was received in the warehouse.","format":"date-time","nullable":true,"type":"string"},"road_transport_shipment":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateRoadTransportShipmentParams"},"description":"Details of Road Transport Shipment if type is 'road_transport'.","nullable":true},"route_id":{"description":"Unique identifier for the Route.","nullable":true,"type":"integer"},"shipment_duimps":{"description":"A collection of DUIMP related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedShipmentDuimpParams"},"description":"Details of the DUIMP associated with this Shipment."},"type":"array"},"shipment_export_declarations":{"description":"A collection of Export Declarations related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedShipmentExportDeclarationParams"},"description":"Details of the Export Declarations associated with this Shipment."},"type":"array"},"shipment_import_declarations":{"description":"A collection of Import Declarations related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedShipmentImportDeclarationParams"},"description":"Details of the Import Declarations associated with this Shipment."},"type":"array"},"shipment_import_licenses":{"description":"A collection of Import Licenses related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedShipmentImportLicenseParams"},"description":"Details of the Import Licenses associated with this Shipment."},"type":"array"},"total_gross_weight":{"description":"Total gross weight associated with the Shipment.","format":"decimal","nullable":true,"type":"string"},"total_net_weight":{"description":"Total net weight associated with the Shipment.","format":"decimal","nullable":true,"type":"string"},"transportables":{"description":"A collection of Transportables related to this Shipment.","items":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateTransportableParams"},"description":"Details of the Transportable associated with this Shipment."},"type":"array"},"type":{"description":"Type of the Shipment.","enum":["AIR_TRANSPORT","MARITIME_TRANSPORT","ROAD_TRANSPORT"],"nullable":true,"type":"string"},"warehouse_free_time_days":{"description":"Number of days of warehouse free time.","nullable":true,"type":"integer"}},"title":"NestedUpdateForeignTradeShipmentParams","type":"object"},"ExportDeclarationParams":{"description":"Available parameters to create or update an Export Declaration.","example":{"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"},"properties":{"channel":{"description":"The Export Declaration channel.","enum":["GREEN","ORANGE","RED"],"nullable":true,"type":"string"},"customs_cleared_at":{"description":"The timestamp when the Export Declaration was customs cleared.","format":"date-time","nullable":true,"type":"string"},"endorsed_at":{"description":"The timestamp when the Export Declaration was endorsed.","format":"date-time","nullable":true,"type":"string"},"extra":{"description":"Additional information related to the Export Declaration.","nullable":true,"type":"object"},"last_updated_at":{"description":"The timestamp when the Export Declaration was last updated.","format":"date-time","nullable":true,"type":"string"},"number":{"description":"The Export Declaration number.","type":"string"},"registered_at":{"description":"The timestamp when the Export Declaration was registered.","format":"date-time","nullable":true,"type":"string"},"status":{"description":"The current status of the Export Declaration.","enum":["ACD_IN_PROCESSING","CANCELED_BY_CUSTOMS","CANCELED_BY_CUSTOMS_AT_THE_REQUEST_OF_THE_EXPORTER","CANCELED_BY_THE_EXPORTER","CANCELED_DUE_TO_EXPIRATION_OF_DEADLINE","CLEARED","CUSTOMS_CLEARANCE_AWAITING_RESOLUTION_OF_ADMINISTRATIVE_ISSUES","DECLARATION_SUBMITTED_FOR_CUSTOMS_CLEARANCE","EARLY_SHIPMENT_AUTHORIZED","EARLY_SHIPMENT_PENDING_AUTHORIZATION","EARLY_SHIPMENT_PENDING_LPCO","ENDORSED","FISCAL_ANALYSIS_COMPLETED","IN_PREPARATION","INTERRUPTED","LPCO_CLEARANCE_PENDING","REGISTERED","RELEASED_WITHOUT_CUSTOMS_INSPECTION_GREEN_CHANNEL","SELECTED_FOR_CUSTOMS_CONFERENCE","SELECTED_FOR_INSPECTION_ORANGE_OR_RED_CHANNEL","UNDER_FISCAL_ANALYSIS","RFB_CANCEL_EXPORTER_REQUEST"],"nullable":true,"type":"string"},"status_response":{"description":"The response status for the Export Declaration.","enum":["PENDING","NOT_FOUND","FOUND","INVALID"],"nullable":true,"type":"string"}},"title":"ExportDeclarationParams","type":"object"},"ParcelShipment":{"additionalProperties":false,"description":"This schema defines a 'Parcel Shipment' data structure.","example":{"ata":null,"atd":"2023-05-15T10:15:00Z","courier":{"code":"COR","id":1,"name":"Correios"},"destination_address":"Av. B, 456, São Paulo, SP, Brasil","destination_country_code":"BR","eta":"2023-05-20T12:00:00Z","etd":"2023-05-15T10:00:00Z","id":1,"origin_address":"Rua A, 123, Rio de Janeiro, RJ, Brasil","origin_country_code":"BR","slug":"CourierWidget","tracking_number":"BR1234567890"},"properties":{"ata":{"description":"ATA (Actual Time of Arrival).","format":"date-time","nullable":true,"type":"string"},"atd":{"description":"ATD (Actual Time of Departure).","format":"date-time","nullable":true,"type":"string"},"courier":{"additionalProperties":{"$ref":"#/components/schemas/Courier"},"description":"The courier used for the Parcel Shipment.","nullable":true,"type":"object"},"destination_address":{"description":"Destination address for the Parcel Shipment.","nullable":true,"type":"string"},"destination_country_code":{"description":"The destination country code of the Parcel Shipment.","nullable":true,"type":"object"},"eta":{"description":"ETA (Estimated Time of Arrival).","format":"date-time","nullable":true,"type":"string"},"etd":{"description":"ETD (Estimated Time of Departure).","format":"date-time","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Parcel Shipment.","type":"integer"},"origin_address":{"description":"Origin address for the Parcel Shipment.","nullable":true,"type":"string"},"origin_country_code":{"description":"The origin country code of the Parcel Shipment.","nullable":true,"type":"object"},"slug":{"description":"Courier slug for the Parcel Shipment.","type":"string"},"tracking_number":{"description":"Tracking number for the Parcel Shipment.","type":"string"}},"required":["tracking_number","slug"],"title":"ParcelShipment","type":"object"},"Transportable":{"description":"This schema defines a 'Transportable' data structure.","example":{"cargo":null,"container":{"actual_return_empty_container_at":"2023-01-01T00:00:00Z","code":"MSDU5953962","cubic_meters":30.0,"demurrage_free_time_start_at":"2023-01-01T00:00:00Z","dispatch_number":"DISP12345","estimated_return_empty_container_at":"2023-01-01T00:00:00Z","events":[{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"CNXIS","status":"Empty to Shipper","transport":null,"voyage":"CNXISTRB"},{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"CNNGB","status":"Export received at CY","transport":null,"voyage":"CNNGBTRB"},{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"CNNGB","status":"Export Loaded on Vessel","transport":"9484455","voyage":"CNNGBUX333A"},{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"DOCAU","status":"Full Transshipment Discharged","transport":"9484455","voyage":"DOCAUUX338R"},{"datetime":"2023-01-01T00: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","is_stackable":true,"load_type":"GENERAL_CARGO","max_weight_kg":"100.123","observations":"observation example","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,"transport_document":"TDOC67890","type":"DRY"},"id":123,"type":"CONTAINER"},"properties":{"cargo":{"additionalProperties":{"$ref":"#/components/schemas/Cargo"},"description":"Details of the Cargo if the Transportable is of type 'cargo'.","nullable":true},"container":{"additionalProperties":{"$ref":"#/components/schemas/Container"},"description":"Details of the Container if the Transportable is of type 'container'.","nullable":true},"id":{"description":"Unique identifier for the Transportable.","type":"integer"},"type":{"description":"The type of Transportable.","enum":["CONTAINER","CARGO"],"type":"string"}},"required":["id","type"],"title":"Transportable","type":"object"},"NestedCreateInvoiceParams":{"description":"Available nested parameters to create an Invoice.","example":{"currency_code":"USD","discount":"10","emitted_at":"2023-11-04T10:00:00Z","incoterm":"CPT","items":[{"batch_number":"BATCH-6789","batch_validity_date":"2024-10-29T00:00:00Z","order_item_line_reference":"1","order_reference_code":"ORC-123","product_description":"Product A","product_sku":"SKU-12345","production_date":"2023-10-29T00:00:00Z","quantity":"5","total_gross_weight_kg":"80.00","unitary_amount":"12.34"}],"number":"INV-2023-001"},"properties":{"currency_code":{"description":"Unique identifier for the Currency.","nullable":true,"type":"string"},"discount":{"description":"The discount on the Invoice.","format":"number","type":"string"},"emitted_at":{"description":"The timestamp when the Invoice was emitted.","format":"date-time","type":"string"},"incoterm":{"description":"The incoterm code specifying the delivery terms for the Invoice.","enum":["EXW","FCA","FAS","FOB","CPT","CIP","CFR","CIF","DAP","DPU","DDP","SISCOMEX_OCV","SISCOMEX_COST_PLUS_FREIGHT","SISCOMEX_COST_PLUS_INSURANCE"],"type":"string"},"items":{"items":{"additionalProperties":{"$ref":"#/components/schemas/InvoiceItem"},"description":"Items of the Invoice."},"type":"array"},"number":{"description":"The Invoice number.","type":"string"}},"required":["number","emitted_at","incoterm","items"],"title":"NestedCreateInvoiceParams","type":"object"},"NestedInternationalFreightParams":{"description":"Available parameters to create or update an International Freight.","example":{"booking_discharge_airport_id":4,"booking_discharge_port_id":4,"booking_eta":"2023-10-29T00:00:00Z","booking_etd":"2023-10-29T00:00:00Z","booking_loading_airport_id":3,"booking_loading_port_id":3,"cargo_attributes":["REEFER"],"currency_code":"USD","freight_cost_collect":"1250.00","freight_cost_prepaid":"1250.00","freight_cost_road":"1250.00","freight_forwarder":"ABC Shipping","planned_boarding_date":"2023-10-29T00:00:00Z","port_terminal_id":null,"quotation_number":"Q123456","sealine_id":2,"type":"PREPAID","vessel_id":1,"voyage_number":"123A"},"properties":{"booking_discharge_airport_id":{"description":"Identifier for the discharge airport associated with the Shipment.","nullable":true,"type":"integer"},"booking_discharge_port_id":{"description":"Identifier for the discharge port associated with the Shipment.","nullable":true,"type":"integer"},"booking_eta":{"description":"ETA (Estimated Time of Arrival) for the Booking.","format":"date-time","nullable":true,"type":"string"},"booking_etd":{"description":"ETD (Estimated Time of Departure) for the Booking.","format":"date-time","nullable":true,"type":"string"},"booking_loading_airport_id":{"description":"Identifier for the loading airport associated with the Shipment.","nullable":true,"type":"integer"},"booking_loading_port_id":{"description":"Identifier for the loading port associated with the Shipment.","nullable":true,"type":"integer"},"cargo_attributes":{"description":"Cargo attributes (e.g. reefer, dangerous goods).","items":{"enum":["REEFER","TEMPERATURE_CONTROLLED","DANGEROUS_GOODS","BATTERY_LITHIUM","OVERSIZED","HEAVY_LIFT","FRAGILE","HIGH_VALUE","PERISHABLE","FOOD_GRADE","PHARMA","LIVE_ANIMALS"],"type":"string"},"nullable":true,"type":"array"},"currency_code":{"description":"Information about the currency used for the International Freight.","nullable":true,"type":"string"},"freight_cost_collect":{"description":"The Collect cost associated with the International Freight.","format":"number","nullable":true,"type":"string"},"freight_cost_prepaid":{"description":"The Prepaid cost associated with the International Freight.","format":"number","nullable":true,"type":"string"},"freight_cost_road":{"description":"The Road cost associated with the International Freight.","format":"number","nullable":true,"type":"string"},"freight_forwarder":{"description":"The name of the freight forwarder for the International Freight.","nullable":true,"type":"string"},"planned_boarding_date":{"description":"Planned Boarding Date","format":"date-time","nullable":true,"type":"string"},"port_terminal_id":{"description":"Identifier for the Port Terminal associated with the International Freight.","nullable":true,"type":"integer"},"quotation_number":{"description":"The quotation number associated with the International Freight.","nullable":true,"type":"string"},"sealine_id":{"description":"Details of the sea line or shipping company associated with the Shipment.","nullable":true,"type":"integer"},"type":{"description":"The type of International Freight.","enum":["BID","NEGOTIATION_SPOT","PREPAID","COLLECT"],"nullable":true,"type":"string"},"vessel_id":{"description":"Details of the Vessel used for transporting the cargo.","nullable":true,"type":"integer"},"voyage_number":{"description":"Identifier of the Voyage.","nullable":true,"type":"string"}},"title":"NestedInternationalFreightParams","type":"object"},"Product":{"description":"This schema defines a 'Product' data structure.","example":{"multiple_package_per_container_ft20":500,"category":"Suspension","package_measurement_unit":"PAIRS","extra":null,"package_capacity":"4","multiple_package_type":"BOXES","family":"Suspension and Handling","pallets_per_container_ft40":20,"code":"REF1234","translated_descriptions":null,"manufacturer":"Schneider-Rutherford","multiple_package_measurement_unit":"BOXES","package_type":"BOTTLES","description":"Shock Absorbers","pallets_per_container_ft20":10,"id":123,"package_code":"PR017","content_type":"PAIRS","content_capacity":"1.0","content_measurement_unit":"BOXES","packages_per_container_ft20":1000,"additional_details":null,"multiple_code":"REF1234","cubage_per_package":"0.03","gross_weight_per_package":"10.5","packages_per_pallet":50,"mercosul_code":"8708.80.00","dumping":false,"packages_per_container_ft40":2000,"internal_codes":[{"code":"REF5678","id":1,"label":"Client internal code"},{"code":"CODE-2","id":1,"label":"Supplier code"}],"net_weight_per_package":"9.8","product_foreign_operators":[{"cnae":"","contact_details":"Contact Details","description":"Description","document_type":"CNPJ","id":1,"internal_code":"123123","logo_url":null,"nickname":"Nickname","official_document":"11111111111111","official_name":"Actor","opening_date":"2023-01-01","roles":[{"access_group":{"slug":"access_group"},"role":"CARGO_OWNER"}],"trading_name":"Trading Name","verified":true}],"multiple_package_per_container_ft40":1000,"multiple_package_capacity":"30","content_code":"REF1234"},"properties":{"multiple_package_per_container_ft20":{"description":"Estimated number of packages fitting by volume (cubage) in a 20ft container.","nullable":true,"type":"integer"},"category":{"description":"Category of the product.","nullable":true,"type":"string"},"package_measurement_unit":{"description":"Package Measurement Unit of the product.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"extra":{"description":"Extra information related to the product.","nullable":true,"type":"object"},"package_capacity":{"description":"Package capacity of the product.","format":"decimal","nullable":true,"type":"string"},"multiple_package_type":{"description":"Type of the multi-package unit (e.g. box, pallet, bag).","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"family":{"description":"Family of the product.","nullable":true,"type":"string"},"pallets_per_container_ft40":{"description":"Estimated number of pallets that fit into a 40ft container.","nullable":true,"type":"integer"},"has_unitization":{"description":"If Product has Unitization","nullable":true,"type":"boolean"},"code":{"description":"Code (SKU) of the product.","type":"string"},"translated_descriptions":{"description":"Translated descriptions related to the product.","nullable":true,"type":"json"},"manufacturer":{"description":"Manufacturer of the product.","nullable":true,"type":"string"},"multiple_package_measurement_unit":{"description":"Multiple Package Measurement Unit of the product.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"has_containerization":{"description":"If Product has Containerization","nullable":true,"type":"boolean"},"package_type":{"description":"Package Type of the product.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"description":{"description":"Description of the product.","type":"string"},"pallets_per_container_ft20":{"description":"Estimated number of pallets that fit into a 20ft container.","nullable":true,"type":"integer"},"id":{"description":"Unique identifier for the Product.","type":"integer"},"package_code":{"description":"Package code of the product.","nullable":true,"type":"string"},"content_type":{"description":"Measurement unit type for the package contents (e.g. kg, liter, unit).","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"has_palletization":{"description":"If Product has Palletization","nullable":true,"type":"boolean"},"content_capacity":{"description":"The capacity value (e.g. 1.5 for 1.5L or 1.5kg) of the content per package.","format":"decimal","nullable":true,"type":"string"},"content_measurement_unit":{"description":"Unit used to quantify the product content.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"packages_per_container_ft20":{"description":"Estimated number of packages that fit into a 20ft container.","nullable":true,"type":"integer"},"additional_details":{"description":"Additional details of the product.","nullable":true,"type":"string"},"multiple_code":{"description":"Code identifying the multi-package configuration.","nullable":true,"type":"string"},"cubage_per_package":{"description":"Cubage (volume) per package, in cubic meters.","format":"decimal","nullable":true,"type":"string"},"has_content":{"description":"If Product has Content","nullable":true,"type":"boolean"},"gross_weight_per_package":{"description":"Gross weight per individual package, including packaging material.","format":"decimal","nullable":true,"type":"string"},"packages_per_pallet":{"description":"Total number of packages that fit on a standard pallet.","nullable":true,"type":"integer"},"mercosul_code":{"description":"Mercosul Code (NCM) of the product.","nullable":true,"type":"string"},"dumping":{"description":"If Product is subject to dumping","nullable":true,"type":"boolean"},"packages_per_container_ft40":{"description":"Estimated number of packages that fit into a 40ft container.","nullable":true,"type":"integer"},"internal_codes":{"description":"An array of internal codes of this product.","items":{"properties":{"code":{"description":"Code for the Internal Code.","type":"string"},"id":{"description":"Unique identifier for the Internal Code.","type":"integer"},"label":{"description":"Label for the Internal Code.","type":"string"}},"type":"object"},"type":"array"},"net_weight_per_package":{"description":"Net weight per individual package, excluding packaging material.","format":"decimal","nullable":true,"type":"string"},"product_foreign_operators":{"description":"An array of Actor IDs to be associated as foreign operators for the product.","items":{"$ref":"#/components/schemas/Actor"},"type":"array"},"multiple_package_per_container_ft40":{"description":"Estimated number of packages fitting by volume (cubage) in a 40ft container.","nullable":true,"type":"integer"},"multiple_package_capacity":{"description":"Multiple package capacity of the product.","format":"decimal","nullable":true,"type":"string"},"content_code":{"description":"Internal or external code identifying the product content type.","nullable":true,"type":"string"}},"required":["id","description","code"],"title":"Product","type":"object"},"NestedCreateInvoiceItemParams":{"description":"Available nested parameters to create an Invoice Item.","example":{"batch_number":"BATCH-6789","batch_validity_date":"2024-10-29T00:00:00Z","id":1,"order_item_line_reference":"1","order_reference_code":"ORC-123","product_description":"Product A","product_sku":"SKU-12345","production_date":"2023-10-29T00:00:00Z","quantity":"5","total_gross_weight_kg":"80.00","unitary_amount":"12.34"},"properties":{"batch_number":{"description":"The batch number for the Product.","nullable":true,"type":"string"},"batch_validity_date":{"description":"The bacth validity date for the Product.","format":"date-time","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Invoice Item.","type":"integer"},"order_item_line_reference":{"description":"The order item line reference","nullable":true,"type":"string"},"order_reference_code":{"description":"The order reference code","nullable":true,"type":"string"},"product_description":{"description":"A description of the Product in the Invoice Item.","nullable":true,"type":"string"},"product_sku":{"description":"The SKU (Stock Keeping Unit) of the Product in the Invoice Item.","type":"string"},"production_date":{"description":"The production date for the Product.","format":"date-time","nullable":true,"type":"string"},"quantity":{"description":"The quantity of the product in the Invoice Item.","format":"number","type":"string"},"total_gross_weight_kg":{"description":"Total gross weight in kg","format":"number","nullable":true,"type":"string"},"unitary_amount":{"description":"The unitary amount or price of the Product.","format":"number","nullable":true,"type":"string"}},"title":"NestedCreateInvoiceItemParams","type":"object"},"NestedUpdateCargoParams":{"description":"Available nested parameters to update a Cargo.","example":{"cubic_weight":"200","dimensions":"2 3 4","id":1,"measurement_unit":"KILOGRAMS","quantity":"100","volume_cubic_meters":"10","weight_kg":"100"},"properties":{"cubic_weight":{"description":"The cubic weight of the Cargo.","nullable":true,"type":"string"},"dimensions":{"description":"Dimensions of the Cargo.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Cargo.","type":"integer"},"measurement_unit":{"description":"The unit of measurement used for the Cargo.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"type":"string"},"quantity":{"description":"Quantity of the Cargo.","type":"string"},"volume_cubic_meters":{"description":"Volume of the Cargo in cubic meters.","nullable":true,"type":"string"},"weight_kg":{"description":"Weight of the Cargo linked to the measurement unit.","nullable":true,"type":"string"}},"title":"NestedUpdateCargoParams","type":"object"},"InternationalFreight":{"description":"This schema defines a 'International Freight' data structure.","example":{"booking_discharge_airport":{"city_iata_code":"SAO","iata_code":"GRU","icao_code":"SBGR","id":2736,"latitude":-22.816668,"longitude":-45.216667,"name":"Aeroporto Internacional Guarulhos","timezone":"America/Sao_Paulo"},"booking_discharge_port":{"country":{"code":"BR","iso3":"BRA","name":"Brazil"},"id":123,"latitude":-23.951,"longitude":-46.354,"name":"Santos","unlocode":"BRSSZ"},"booking_eta":"2023-10-29T00:00:00Z","booking_etd":"2023-10-29T00:00:00Z","booking_loading_airport":{"city_iata_code":"SAO","iata_code":"GRU","icao_code":"SBGR","id":2736,"latitude":-22.816668,"longitude":-45.216667,"name":"Aeroporto Internacional Guarulhos","timezone":"America/Sao_Paulo"},"booking_loading_port":{"country":{"code":"BR","iso3":"BRA","name":"Brazil"},"id":123,"latitude":-23.951,"longitude":-46.354,"name":"Santos","unlocode":"BRSSZ"},"cargo_attributes":["REEFER"],"currency":{"code":"USD","name":"US Dollar","symbol":"$"},"freight_cost_collect":"1250.00","freight_cost_prepaid":"1250.00","freight_cost_road":null,"freight_cost_total":"2500.00","freight_forwarder":"ABC Shipping","id":1,"planned_boarding_date":"2023-10-29T00:00:00Z","port_terminal":{"id":123,"name":"Santos Brasil"},"quotation_number":"Q123456","sealine":{"id":1,"nickname":"Maersk","scac":"MAEU"},"type":"PREPAID","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":"123A"},"properties":{"booking_discharge_airport":{"additionalProperties":{"$ref":"#/components/schemas/Airport"},"description":"Details of the Airport where the cargo is discharged","nullable":true},"booking_discharge_port":{"additionalProperties":{"$ref":"#/components/schemas/MaritimePort"},"description":"Details of the Port where the cargo is discharged","nullable":true},"booking_eta":{"description":"ETA (Estimated Time of Arrival) for the Booking.","format":"date-time","nullable":true,"type":"string"},"booking_etd":{"description":"ETD (Estimated Time of Departure) for the Booking.","format":"date-time","nullable":true,"type":"string"},"booking_loading_airport":{"additionalProperties":{"$ref":"#/components/schemas/Airport"},"description":"Details of the Airport where the cargo is loaded","nullable":true},"booking_loading_port":{"additionalProperties":{"$ref":"#/components/schemas/MaritimePort"},"description":"Details of the Port where the cargo is loaded","nullable":true},"cargo_attributes":{"description":"Cargo attributes (e.g. reefer, dangerous goods).","items":{"enum":["REEFER","TEMPERATURE_CONTROLLED","DANGEROUS_GOODS","BATTERY_LITHIUM","OVERSIZED","HEAVY_LIFT","FRAGILE","HIGH_VALUE","PERISHABLE","FOOD_GRADE","PHARMA","LIVE_ANIMALS"],"type":"string"},"nullable":true,"type":"array"},"currency":{"additionalProperties":{"$ref":"#/components/schemas/Currency"},"description":"Information about the currency used for the International Freight.","nullable":true},"freight_cost_collect":{"description":"The Collect cost associated with the International Freight.","format":"number","nullable":true,"type":"string"},"freight_cost_prepaid":{"description":"The Prepaid cost associated with the International Freight.","format":"number","nullable":true,"type":"string"},"freight_cost_road":{"description":"The Road cost associated with the International Freight.","format":"number","nullable":true,"type":"string"},"freight_cost_total":{"description":"The Total cost associated with the International Freight.","format":"number","type":"string"},"freight_forwarder":{"description":"The name of the freight forwarder for the International Freight.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the International Freight.","type":"integer"},"planned_boarding_date":{"description":"Planned Boarding Date","format":"date-time","nullable":true,"type":"string"},"port_terminal":{"additionalProperties":{"$ref":"#/components/schemas/PortTerminal"},"description":"Details of the Port Terminal associated with the International Freight.","nullable":true},"quotation_number":{"description":"The quotation number associated with the International Freight.","nullable":true,"type":"string"},"sealine":{"additionalProperties":{"$ref":"#/components/schemas/Sealine"},"description":"Details of the sea line or shipping company associated with the Shipment.","nullable":true},"type":{"description":"The type of International Freight.","enum":["BID","NEGOTIATION_SPOT","PREPAID","COLLECT"],"nullable":true,"type":"string"},"vessel":{"additionalProperties":{"$ref":"#/components/schemas/Vessel"},"description":"Details of the Vessel used for transporting the cargo.","nullable":true},"voyage_number":{"description":"Identifier of the Voyage.","nullable":true,"type":"string"}},"required":["id"],"title":"InternationalFreight","type":"object"},"NestedCreateRoadTransportShipmentParams":{"description":"Available nested parameters to create a Foreign Trade Road Transport Shipment.","example":{"crt":"CRT2024001","destination":"Buenos Aires, Argentina","origin":"São Paulo, Brasil","type":"FTL"},"properties":{"crt":{"description":"CRT associated with the Shipment.","nullable":true,"type":"string"},"destination":{"description":"The destination of the Shipment.","nullable":true,"type":"string"},"origin":{"description":"The origin of the Shipment.","nullable":true,"type":"string"},"type":{"description":"Type of the Road Transport Shipment","enum":["FCL","FTL","LTL"],"nullable":true,"type":"string"}},"title":"NestedCreateRoadTransportShipmentParams","type":"object"},"CreateDocumentParams":{"description":"Available parameters to create a Document.","example":{"description":"The description of Document","external_id":"1234","file":"<binary>","invoice_id":30,"parent_document_id":40,"type":"SHIPMENT_DOCUMENT"},"properties":{"description":{"description":"The description of the Document.","nullable":true,"type":"string"},"external_id":{"description":"The external id of the Document.","nullable":true,"type":"string"},"file":{"description":"The file associated with this Document.","format":"binary","type":"string"},"invoice_id":{"description":"ID of the associated Invoice.","nullable":true,"type":"integer"},"parent_document_id":{"description":"ID of the parent Document.","nullable":true,"type":"integer"},"type":{"description":"The type of Document.","enum":["ANALYSIS_CERTIFICATE","BILL_OF_LADING","BOOKING","BRAZILIAN_INVOICE","COLLECT_ORDER","COMMERCIAL_INVOICE","CONTAINER_ARRIVAL_NOTICE","CONTAINER_DAMAGE","CONTAINER_PROOF_OF_RETURN","CORRECTION_LETTER","CUSTOMS_TRANSIT_DECLARATION","DANGEROUS_GOODS_REQUEST","DI_RECTIFICATION_STATEMENT","DRAUGHT_REPORT","EXPORT_DECLARATION","EXPORT_DECLARATION_DUE","FREIGHT_QUOTE","FREIGHT_RECEIPTS","FUMIGATION_CERTIFICATE","GRU_ANVISA","HEALTH_CERTIFICATE","ICMS","IMPORT_DECLARATION","IMPORT_DECLARATION_DI","IMPORT_DECLARATION_DUIMP","IMPORT_LICENSE","IMPORT_LICENSE_LI","INSPECTION_CERTIFICATE","INSURANCE_POLICY","INVOICE","LPCO","MAPA_APPROVAL","MDFE","MERCHANT_MARINE_DOCUMENT","ORDER_CONFIRMATION","ORIGIN_CERTIFICATE","OTHER","PACKING_LIST","PHYTOSANITARY_CERTIFICATE","PROFORMA_INVOICE","PROOF_OF_DELIVERY","PURCHASE_ORDER","QUALITY_CERTIFICATE","SALES_ORDER","SHIPPING_ADVICE","SHIPPING_INSTRUCTIONS","TRANSPORT_ACKNOWLEDGMENT","VETERINARY_CERTIFICATE","WEIGHT_AND_QUALITY_CERTIFICATE","WEIGHT_CERTIFICATE","HAWB","CRT","SHIPMENT_DOCUMENT","FOREIGN_EXCHANGE_CONTRACT","PROOF_OF_PAYMENT","SHIPPING_DOCUMENTS_FOR_APPROVAL","APPROVED_SHIPPING_DOCUMENTS","SHIPMENT_PRE_ALERT","DEBIT_NOTE","SALES_CONTRACT","DATE_CERTIFICATE","CARBENDAZIM_TEST_REPORT","WOOD_PACKAGING_DECLARATION","ADDITIONAL_INSURANCE_DOCUMENTS","MIC","DRAFT_CO","DRAFT_BL","ISF_5","ISF_10","LAB_ANALYSIS_REPORT","SANITARY_CERTIFICATE","COST_CLOSING","STUFFING_PLAN"],"type":"string"}},"required":["type","file"],"title":"CreateDocumentParams","type":"object"},"NestedUpdateParcelShipmentParams":{"description":"Parameters to update a Parcel Shipment.","example":{"ata":null,"atd":"2023-05-15T10:15:00Z","courier_id":1,"destination_address":"Av. B, 456, São Paulo, SP, Brasil","destination_country_code":"BR","eta":"2023-05-20T12:00:00Z","etd":"2023-05-15T10:00:00Z","id":1,"origin_address":"Rua A, 123, Rio de Janeiro, RJ, Brasil","origin_country_code":"BR","slug":"CourierWidget","tracking_number":"BR1234567890"},"properties":{"ata":{"description":"ATA (Actual Time of Arrival).","format":"date-time","nullable":true,"type":"string"},"atd":{"description":"ATD (Actual Time of Departure).","format":"date-time","nullable":true,"type":"string"},"courier_id":{"description":"ID of the courier handling the shipment.","nullable":true,"type":"integer"},"destination_address":{"description":"Destination address for the Parcel Shipment.","nullable":true,"type":"string"},"destination_country_code":{"description":"Country code of the destination.","nullable":true,"type":"string"},"eta":{"description":"ETA (Estimated Time of Arrival).","format":"date-time","nullable":true,"type":"string"},"etd":{"description":"ETD (Estimated Time of Departure).","format":"date-time","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Parcel Shipment.","type":"integer"},"origin_address":{"description":"Origin address for the Parcel Shipment.","nullable":true,"type":"string"},"origin_country_code":{"description":"Country code of the origin.","nullable":true,"type":"string"},"slug":{"description":"Courier slug for the Parcel Shipment.","type":"string"},"tracking_number":{"description":"Tracking number for the Parcel Shipment.","type":"string"}},"title":"NestedUpdateParcelShipmentParams","type":"object"},"ProductsResponse":{"description":"An array containing details of multiple products.","properties":{"data":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"}},"title":"ProductsResponse","type":"object"},"Courier":{"description":"This schema defines a 'Courier' data structure.","example":{"code":"COR","id":1,"logo_url":"https://example.com/logos/correios.png","name":"Correios"},"properties":{"code":{"description":"Unique code for the Courier (3 characters).","nullable":false,"type":"string"},"id":{"description":"Unique identifier for the Courier.","nullable":false,"type":"integer"},"logo_url":{"description":"URL to the Courier's logo.","nullable":true,"type":"string"},"name":{"description":"Name of the Courier.","nullable":false,"type":"string"}},"required":["id","name","code"],"title":"Courier","type":"object"},"MaritimeTransportShipment":{"description":"This schema defines a 'Maritime Transport Shipment' data structure.","example":{"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,"nickname":"Maersk","scac":"MAEU"},"tracking_discharge_port":"BRRIG","tracking_key":"BILL_OF_LADING","tracking_loading_port":"CNNGB","tracking_number":null,"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"},"properties":{"bl":{"description":"Bill of Lading (BL) reference related to the Shipment.","nullable":true,"type":"string"},"booking":{"description":"Booking reference related to the Shipment.","nullable":true,"type":"string"},"discharge_port":{"additionalProperties":{"$ref":"#/components/schemas/MaritimePort"},"description":"Details of the Port where the cargo is discharged from the Vessel.","nullable":true},"hbl":{"description":"House Bill of Lading (HBL) reference related to the Shipment.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Maritime Transport Shipment.","type":"integer"},"loading_port":{"additionalProperties":{"$ref":"#/components/schemas/MaritimePort"},"description":"Details of the Port where the cargo is loaded onto the Vessel.","nullable":true},"sealine":{"additionalProperties":{"$ref":"#/components/schemas/Sealine"},"description":"Details of the sea line or shipping company associated with the Shipment.","nullable":true},"tracking_discharge_port":{"description":"The Discharge Port found by Automatic Tracking.","nullable":true,"type":"string"},"tracking_key":{"description":"An array of Tracking keys for the Shipment found by Automatic Tracking.","enum":["BILL_OF_LADING","BOOKING","CONTAINER_CODE","HOUSE_BL","TRACKING_NUMBER","VESSEL"],"nullable":true,"type":"string"},"tracking_loading_port":{"description":"The Loading Port found by Automatic Tracking.","nullable":true,"type":"string"},"tracking_number":{"description":"Tracking Number reference related to the Shipment.","nullable":true,"type":"string"},"type":{"description":"The Type of Maritime Transport.","enum":["FCL","LCL","BREAKBULK","BULK_CARGO"],"nullable":true,"type":"string"},"valid_keys":{"description":"An array of Valid keys for the Shipment found by Automatic Tracking.","items":{"enum":["BILL_OF_LADING","BOOKING","CONTAINER_CODE","HOUSE_BL","TRACKING_NUMBER","VESSEL"],"type":"string"},"type":"array"},"vessel":{"additionalProperties":{"$ref":"#/components/schemas/Vessel"},"description":"Details of the Vessel used for transporting the cargo.","nullable":true}},"required":["id","valid_keys"],"title":"MaritimeTransportShipment","type":"object"},"Airport":{"description":"This schema defines an 'Airport' data structure.","example":{"city_iata_code":"SAO","iata_code":"GRU","icao_code":"SBGR","id":2736,"latitude":-22.816668,"longitude":-45.216667,"name":"Aeroporto Internacional Guarulhos","timezone":"America/Sao_Paulo"},"properties":{"city_iata_code":{"description":"The IATA code for the city where the Airport is located.","nullable":true,"type":"string"},"country":{"additionalProperties":{"$ref":"#/components/schemas/Country"},"description":"The Country where the Airport is located.","nullable":true},"iata_code":{"description":"The IATA (International Air Transport Association) code for the Airport.","type":"string"},"icao_code":{"description":"The ICAO (International Civil Aviation Organization) code for the Airport.","nullable":true,"type":"string"},"id":{"description":"The unique identifier for the Airport.","type":"integer"},"latitude":{"description":"The latitude coordinates of the Airport.","nullable":true,"type":"string"},"longitude":{"description":"The longitude coordinates of the Airport.","nullable":true,"type":"string"},"name":{"description":"The name of the Airport.","type":"string"},"timezone":{"description":"The timezone in which the Airport is located.","nullable":true,"type":"string"}},"required":["id","name","iata_code"],"title":"Airport","type":"object"},"Subsidiary":{"description":"This schema defines a 'Subsidiary' data structure.","example":{"id":1,"name":"Subsidiary"},"properties":{"id":{"description":"Unique identifier for the Subsidiary.","type":"integer"},"name":{"description":"The official name of the Subsidiary.","type":"string"}},"required":["id","name"],"title":"Subsidiary","type":"object"},"CostExpense":{"description":"This schema defines an 'Cost Expense' data structure.","example":{"id":123,"name":"Cost Expense","slug":"cost_expense"},"properties":{"id":{"description":"Unique identifier for the Cost Expense.","type":"integer"},"name":{"description":"Translated names related to the Cost Expense.","type":"string"},"slug":{"description":"Slug the Cost Expense.","type":"string"}},"required":["id","name","slug"],"title":"CostExpense","type":"object"},"Trailer":{"description":"This schema defines a 'Trailer' data structure.","example":{"id":123,"is_refrigerated":true,"plate":"ABC123","speed_limit_dry":100,"speed_limit_wet":80,"tare_weight_kg":"5000.10","temperature_max":10,"temperature_min":-20,"tracker_brand":"SASCAR","tracker_id":456,"type":"BOX"},"properties":{"id":{"description":"Unique identifier for the Trailer.","type":"integer"},"is_refrigerated":{"description":"Indicates whether the Trailer is refrigerated (true) or not (false).","type":"boolean"},"plate":{"description":"The plate of the Trailer.","type":"string"},"speed_limit_dry":{"description":"The speed limit for the Trailer in dry conditions.","nullable":true,"type":"integer"},"speed_limit_wet":{"description":"The speed limit for the Trailer in wet conditions.","nullable":true,"type":"integer"},"tare_weight_kg":{"description":"The weight of the empty Trailer in kilograms.","format":"decimal","nullable":true,"type":"string"},"temperature_max":{"description":"The maximum temperature the refrigerated Trailer can maintain.","nullable":true,"type":"integer"},"temperature_min":{"description":"The minimum temperature the refrigerated Trailer can maintain.","nullable":true,"type":"integer"},"tracker_brand":{"description":"The brand of the tracker on the Trailer.","enum":["SASCAR","OMNILINK"],"type":"string"},"tracker_id":{"description":"The unique identifier of the tracker on the Trailer.","nullable":true,"type":"integer"},"type":{"description":"The type of the Trailer.","enum":["BOX","SLIDER","BUGGY_20","BUGGY_40"],"type":"string"}},"required":["id","type","plate","is_refrigerated"],"title":"Trailer","type":"object"},"SalesOrder":{"description":"This schema defines a 'Sales Order' (SO) data structure.","example":{"id":123,"items":[{"balance":"10.0","balance_shipped":"10.0","cubage_cubic_meters":null,"dispatch_number":null,"factory_delivery_at":null,"factory_estimated_delivery_at":null,"gross_weight_kg":null,"id":123,"item_status":null,"line_number":1,"line_reference":"1.1","measurement_unit_sap":null,"necessity_type":null,"net_weight_kg":null,"order_currency":{"code":"USD","name":"US Dollar"},"order_item_reference":null,"order_request_number":null,"order_total_value":null,"order_unit_value":null,"order_value":null,"product":{"code":"REF1234","description":"Descrição Produto","id":2,"mercosul_code":"8708.80.00","package_type":"BOTTLES"},"product_description":"Descrição Produto","product_mercosul_code":"8708.80.00","quantity":"20.0","shipment_containers_quantity":null,"shipment_equipment_type":null,"shipment_planned_arrival_at":null,"shipment_planned_boarding_at":null,"supplier_estimated_ready_at":null,"supplier_planned_ready_at":null,"supplier_ready_at":null,"ubc":null}],"order_confirmed_at":"2023-10-29T00:00:00Z","order_received_at":"2023-10-29T00:00:00Z","type":"INDIRECT"},"properties":{"id":{"description":"Unique identifier for the SO.","type":"integer"},"items":{"items":{"additionalProperties":{"$ref":"#/components/schemas/SalesOrderItem"},"description":"Details of the Items associated with this SO."},"type":"array"},"order_confirmed_at":{"description":"Timestamp indicating when the order was confirmed.","format":"date-time","nullable":true,"type":"string"},"order_received_at":{"description":"Timestamp indicating when the order was received.","format":"date-time","nullable":true,"type":"string"},"type":{"description":"Type indicating the type of acquisition of the SO.","enum":["DIRECT","INDIRECT"],"type":"string"}},"required":["id","type","items"],"title":"SalesOrder","type":"object"},"DefaultListResponse":{"description":"This schema defines a 'Default List Response' data structure.","properties":{"data":{"items":{"properties":{"id":{"description":"Entity ID.","type":"integer"}},"required":["id"],"type":"object"},"type":"array"}},"title":"DefaultListResponse","type":"object"},"CreateBasePartnershipParams":{"description":"Parameters to create or update a Partnership and its associated Actor.\n","example":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company","roles":[{"access_group_id":null,"role":"SUPPLIER"}]},"properties":{"contact_details":{"description":"Contact details of the Partnership.","nullable":true,"type":"string"},"description":{"description":"Description of the Partnership.","nullable":true,"type":"string"},"document_type":{"description":"The type of official document. Must be provided along with official_document.","enum":["CNPJ","CPF","TIN","INTERNAL_CODE"],"type":"string"},"internal_code":{"description":"Internal code of the Partnership. As an alternative you can use official_document + document_type to create a partnership.","type":"string"},"name":{"description":"Name/nickname of the Actor.","type":"string"},"official_document":{"description":"The official document that identifies the actor.","type":"string"},"roles":{"description":"List of roles that the Actor will have in the Partnership.","items":{"properties":{"access_group_id":{"description":"The access group associated with this role. Optional.","nullable":true,"type":"integer"},"role":{"description":"The role/function of the actor in the partnership.","enum":["ACQUIRER","AGENT","BANK","BONDED_TERMINAL","CARGO_OWNER","CONTAINER_DEPOT","CUSTOMER","CUSTOMS_BROKER","CUSTOMS_TERMINAL","EXPORTER","FUNDER","FREIGHT_FORWARDER","IMPORTER","INTEGRATOR","INTERNATIONAL_ROAD_CARRIER","MANUFACTURER","NATIONAL_ROAD_CARRIER","SUPPLIER","TRADING","WAREHOUSE"],"type":"string"}},"required":["role"],"type":"object"},"type":"array"}},"required":["roles","name"],"title":"CreateBasePartnershipParams","type":"object"},"MatchingRule":{"description":"This schema defines an 'Matching Rule' data structure.","example":{"operator":"equals","path":"process.foreign_trade_shipment.transportables.container.size_foot_type","table_definition_field":"container_size"},"properties":{"operator":{"description":"Operator for the Matching Rule.","enum":["EQUALS"],"nullable":true,"type":"string"},"path":{"description":"Path for the Matching Rule.","type":"string"},"table_definition_field":{"description":"Table Definition Field for the Matching Rule.","type":"boolean"}},"required":["path","operator","table_definition_field"],"title":"MatchingRule","type":"object"},"RoutesResponse":{"description":"An array containing details of multiple routes.","properties":{"data":{"items":{"$ref":"#/components/schemas/Route"},"type":"array"}},"title":"RoutesResponse","type":"object"},"UpsertHandlerParams":{"description":"Available nested parameters to upsert a Handler.","example":{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"},"properties":{"actor":{"additionalProperties":{"$ref":"#/components/schemas/UpsertPartnershipHandlerParams"},"description":"An Actor object for when upserting the Actor. As an alternative, you can also use actor_id","nullable":true},"actor_id":{"description":"Unique identifier for the Actor. As an alternative, you can also use actor object","nullable":true,"type":"integer"},"business_unit":{"description":"Describes the business unit associated with the Handler.","nullable":true,"type":"string"},"reference":{"description":"Represents an identifier for the Handler","nullable":true,"type":"string"},"secondary_reference":{"description":"Provides an additional reference for the Handler.","nullable":true,"type":"string"}},"title":"UpsertHandlerParams","type":"object"},"NestedUpdateSalesOrderItemParams":{"description":"Available parameters to update a Sales Order Item (SOI).","example":{"cubage_cubic_meters":null,"dispatch_number":null,"factory_delivery_at":null,"factory_estimated_delivery_at":null,"gross_weight_kg":null,"id":1,"item_status":null,"line_number":1,"line_reference":"1.1","measurement_unit_sap":null,"necessity_type":null,"net_weight_kg":null,"order_currency_code":"USD","order_item_reference":null,"order_request_number":null,"order_unit_value":null,"order_value":null,"product_code":"PRD-123","product_id":1,"quantity":"20.0","shipment_containers_quantity":null,"shipment_equipment_type":null,"shipment_planned_arrival_at":null,"shipment_planned_boarding_at":null,"supplier_estimated_ready_at":null,"supplier_planned_ready_at":null,"supplier_ready_at":null,"ubc":null},"properties":{"cubage_cubic_meters":{"description":"Cubage in cubic meters.","format":"number","nullable":true,"type":"string"},"dispatch_number":{"description":"The Dispatch number.","nullable":true,"type":"string"},"factory_delivery_at":{"description":"Factory Delivery At.","format":"date-time","nullable":true,"type":"string"},"factory_estimated_delivery_at":{"description":"Forecast Factory Delivery At.","format":"date-time","nullable":true,"type":"string"},"gross_weight_kg":{"description":"Gross weight in kilograms.","format":"number","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the SOI.","type":"integer"},"item_status":{"description":"Item Status","nullable":true,"type":"string"},"line_number":{"description":"The line number associated with this SOI.","nullable":true,"type":"integer"},"line_reference":{"description":"The line reference associated with this item.","type":"string"},"measurement_unit_sap":{"description":"Measurement unit from SAP.","nullable":true,"type":"string"},"necessity_type":{"description":"Necessity type","nullable":true,"type":"string"},"net_weight_kg":{"description":"Net weight in kilograms.","format":"number","nullable":true,"type":"string"},"order_currency_code":{"description":"Order Currency Code.","nullable":true,"type":"string"},"order_item_reference":{"description":"Order Item Reference.","nullable":true,"type":"string"},"order_request_number":{"description":"Order Request Number.","nullable":true,"type":"string"},"order_unit_value":{"description":"Order Unit Value.","format":"number","nullable":true,"type":"string"},"order_value":{"description":"Order Value.","format":"number","nullable":true,"type":"string"},"product_code":{"description":"Code (SKU) of the product. As an alternative, you can also use product_id","type":"string"},"product_id":{"description":"Unique identifier for the Product. As an alternative, you can also use product_code","type":"integer"},"quantity":{"description":"The quantity of products associated with this SOI.","format":"number","nullable":true,"type":"string"},"shipment_containers_quantity":{"description":"Shipment Containers Quantity.","format":"number","nullable":true,"type":"string"},"shipment_equipment_type":{"description":"Shipment Equipment Type.","nullable":true,"type":"string"},"shipment_planned_arrival_at":{"description":"Shipment Planned Arrival At.","format":"date-time","nullable":true,"type":"string"},"shipment_planned_boarding_at":{"description":"Shipment Planned Boarding At.","format":"date-time","nullable":true,"type":"string"},"supplier_estimated_ready_at":{"description":"Supplier Estimated Readiness At.","format":"date-time","nullable":true,"type":"string"},"supplier_planned_ready_at":{"description":"Supplier Planned Readiness At.","format":"date-time","nullable":true,"type":"string"},"supplier_ready_at":{"description":"Supplier Readiness At.","format":"date-time","nullable":true,"type":"string"},"ubc":{"description":"UBC Code","nullable":true,"type":"string"}},"required":["line_reference"],"title":"NestedUpdateSalesOrderItemParams","type":"object"},"PortSchedulesResponse":{"description":"An array containing details of multiple Port Schedules and the total count.","properties":{"data":{"items":{"$ref":"#/components/schemas/PortSchedule"},"type":"array"},"total_count":{"description":"Total amount of Port Schedules based on the provided filters.","type":"integer"}},"title":"PortSchedulesResponse","type":"object"},"NestedUpdateInvoiceParams":{"description":"Available nested parameters to update an Invoice.","example":{"currency_code":"USD","discount":"10","emitted_at":"2023-11-04T10:00:00Z","id":1,"incoterm":"CPT","items":[{"batch_number":"BATCH-6789","batch_validity_date":"2024-10-29T00:00:00Z","id":1,"order_item_line_reference":"1","order_reference_code":"ORC-123","product_description":"Product A","product_sku":"SKU-12345","production_date":"2023-10-29T00:00:00Z","quantity":"5","total_gross_weight_kg":"80.00","unitary_amount":"12.34"}],"number":"INV-2023-001"},"properties":{"currency_code":{"description":"Unique identifier for the Currency.","nullable":true,"type":"string"},"discount":{"description":"The discount on the Invoice.","format":"number","type":"string"},"emitted_at":{"description":"The timestamp when the Invoice was emitted.","format":"date-time","type":"string"},"incoterm":{"description":"The incoterm code specifying the delivery terms for the Invoice.","enum":["EXW","FCA","FAS","FOB","CPT","CIP","CFR","CIF","DAP","DPU","DDP","SISCOMEX_OCV","SISCOMEX_COST_PLUS_FREIGHT","SISCOMEX_COST_PLUS_INSURANCE"],"type":"string"},"items":{"items":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateInvoiceItemParams"},"description":"Items of the Invoice."},"type":"array"},"number":{"description":"The Invoice number.","type":"string"}},"title":"NestedUpdateInvoiceParams","type":"object"},"InvoiceItem":{"description":"This schema defines a 'Invoice Item' data structure.","example":{"batch_number":"BATCH-6789","batch_validity_date":"2024-10-29T00:00:00Z","id":1,"order_item_line_reference":"1","order_reference_code":"ORC-123","product_description":"Product A","product_sku":"SKU-12345","production_date":"2023-10-29T00:00:00Z","quantity":"5","shipment_quantity":5,"total_amount":"61.70","total_gross_weight_kg":"80.00","unitary_amount":"12.34"},"properties":{"batch_number":{"description":"The batch number for the Product.","type":"string"},"batch_validity_date":{"description":"The bacth validity date for the Product.","format":"date-time","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Invoice Item.","type":"integer"},"order_item_line_reference":{"description":"The order item line reference","nullable":true,"type":"string"},"order_reference_code":{"description":"The order reference code","nullable":true,"type":"string"},"product_description":{"description":"A description of the Product in the Invoice Item.","type":"string"},"product_sku":{"description":"The SKU (Stock Keeping Unit) of the Product in the Invoice Item.","type":"string"},"production_date":{"description":"The production date for the Product.","format":"date-time","nullable":true,"type":"string"},"quantity":{"description":"The quantity of the product in the Invoice Item.","format":"number","type":"string"},"shipment_quantity":{"description":"The quantity of the Product shipped in this Invoice Item.","format":"number","type":"string"},"total_amount":{"description":"The total amount for the Invoice Item.","format":"number","type":"string"},"total_gross_weight_kg":{"description":"Total gross weight in kg","format":"number","nullable":true,"type":"string"},"unitary_amount":{"description":"The unitary amount or price of the Product.","format":"number","type":"string"}},"required":["id","quantity","product_sku","shipment_quantity"],"title":"InvoiceItem","type":"object"},"NestedCreateContainerParams":{"description":"Available nested parameters to create a Container.","example":{"code":"MSDU5953962","cubic_meters":30.0,"demurrage_free_time_start_at":"2023-01-01T00:00:00Z","dispatch_number":"DISP12345","gross_weight_kg":"100.10","hidden":false,"invoice_number":"99999","is_stackable":true,"load_type":"GENERAL_CARGO","max_weight_kg":"100.123","observations":"observation example","seal_code":"SEAL_CODE","secondary_seal_code":"SECONDARY_SEAL_CODE","size_foot_type":"20_FOOT","tare_weight_kg":"100","tracking_manual":true,"transport_document":"TDOC67890","type":"DRY"},"properties":{"code":{"description":"A code associated with the Container.","type":"string"},"cubic_meters":{"description":"The cubic meter the Container.","format":"number","type":"string"},"demurrage_free_time_start_at":{"description":"The starting point to count the container's Free Time before demurrage costs incur.","format":"date-time","nullable":true,"type":"string"},"dispatch_number":{"description":"The Dispatch number.","nullable":true,"type":"string"},"gross_weight_kg":{"description":"Gross weight of the Container in kilograms.","format":"decimal","nullable":true,"type":"string"},"hidden":{"description":"Flag to determine whether the Container should be hidden.","type":"boolean"},"invoice_number":{"description":"Invoice number associated with the Container.","nullable":true,"type":"string"},"is_stackable":{"description":"If is stackable Container.","format":"boolean","type":"string"},"load_type":{"description":"Type of Cargo the Container is designed.","enum":["GENERAL_CARGO","FOOD","PHARMACEUTICALS","WEAPONS","BULK"],"nullable":true,"type":"string"},"max_weight_kg":{"description":"Maximum weight capacity of the Container in kilograms.","format":"decimal","nullable":true,"type":"string"},"observations":{"description":"Container observations.","nullable":true,"type":"string"},"seal_code":{"description":"Code associated with Container Seals.","nullable":true,"type":"string"},"secondary_seal_code":{"description":"Secondary code for Container Seals.","nullable":true,"type":"string"},"size_foot_type":{"description":"Size of the Container in foot.","enum":["STANDARD_10","STANDARD_20","STANDARD_30","STANDARD_40","SPECIAL_20","SPECIAL_30","SPECIAL_40","SPECIAL_45","REDUCED_20","REDUCED_30","REDUCED_40","HC_20","HC_40","HC_45","SHC_20","SHC_40","SHC_45","PALLET_WIDE_40","PALLET_WIDE_45"],"nullable":true,"type":"string"},"tare_weight_kg":{"description":"Tare weight of the Container in kilograms.","format":"decimal","nullable":true,"type":"string"},"tracking_manual":{"default":true,"description":"Flag to determine whether the Container was created or edited manually.","type":"boolean"},"transport_document":{"description":"The Transport Document.","nullable":true,"type":"string"},"type":{"description":"Type of the container.","enum":["BULK","DOUBLE_DOOR","DRY","FLAT_RACK","HARD_TOP","HIGH_CUBE","INSULATED","NON_OPERATING_REEFER","OPEN_TOP","PALLET_WIDE","PLATFORM","REEFER","SIDE_DOOR","SPECIAL","STANDARD","SWAP_BODY","TANK","VENTILATED"],"nullable":true,"type":"string"}},"required":["code"],"title":"NestedCreateContainerParams","type":"object"},"NestedCreateRoadTransportTripPhaseParams":{"description":"Available nested parameters to create a Foreign Trade Road Transport Trip Phase.","example":{"departure_at":"2023-10-29T00:00:00Z","estimated_realized_at":"2023-10-29T00:00:00Z","realized_at":"2023-10-29T00:00:00Z","route_point_id":1},"properties":{"departure_at":{"description":"The timestamp when the Phase started.","format":"date-time","nullable":true,"type":"string"},"estimated_realized_at":{"description":"The estimated timestamp when the Phase was realized.","format":"date-time","nullable":true,"type":"string"},"realized_at":{"description":"The timestamp when the Phase was realized.","format":"date-time","nullable":true,"type":"string"},"route_point_id":{"description":"Unique identifier for the Route Point.","type":"integer"}},"required":["route_point_id"],"title":"NestedCreateRoadTransportTripPhaseParams","type":"object"},"NestedShipmentExportDeclarationParams":{"description":"Available parameters to create or update a Shipment Export Declaration.","example":{"comments":"Any comments","export_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"},"id":1},"properties":{"comments":{"description":"Additional comments or notes related to the Shipment Export Declaration.","nullable":true,"type":"string"},"export_declaration":{"$ref":"#/components/schemas/ExportDeclarationParams"},"id":{"description":"Unique identifier for the Shipment Export Declaration.","type":"integer"}},"title":"NestedShipmentExportDeclarationParams","type":"object"},"NestedUpdateDemurrageParams":{"description":"Available nested parameters to update a Demurrage.","example":{"daily_rate_usd":"10.5","free_time":2},"properties":{"daily_rate_usd":{"description":"The daily rate in USD charged for Demurrage after the free time has expired.","format":"number","type":"string"},"free_time":{"description":"The number of days allowed for free time before Demurrage charges apply.","type":"integer"}},"title":"NestedUpdateDemurrageParams","type":"object"},"Invoice":{"description":"This schema defines an 'Invoice' data structure.","example":{"currency":{"code":"USD","name":"US Dollar","symbol":"$"},"discount":"34.56","emitted_at":"2023-11-04T10:00:00Z","final_value":"1200.00","id":1,"incoterm":"CPT","items":[{"batch_number":"BATCH-6789","batch_validity_date":"2024-10-29T00:00:00Z","id":1,"order_item_line_reference":"1","order_reference_code":"ORC-123","product_description":"Product A","product_sku":"SKU-12345","production_date":"2023-10-29T00:00:00Z","quantity":"5","shipment_quantity":5,"total_amount":"61.70","total_gross_weight_kg":"80.00","unitary_amount":"12.34"}],"number":"INV-2023-001","total_amount":"1234.56","updated_at":"2023-11-04T14:30:00Z"},"properties":{"currency":{"additionalProperties":{"$ref":"#/components/schemas/Currency"},"description":"Information about the currency used for the Invoice."},"discount":{"description":"The discount on the Invoice.","format":"number","type":"string"},"emitted_at":{"description":"The timestamp when the Invoice was emitted.","format":"date-time","type":"string"},"final_value":{"description":"The final value on the Invoice.","format":"number","type":"string"},"id":{"description":"Unique identifier for the Invoice.","type":"integer"},"incoterm":{"description":"The incoterm code specifying the delivery terms for the Invoice.","enum":["EXW","FCA","FAS","FOB","CPT","CIP","CFR","CIF","DAP","DPU","DDP","SISCOMEX_OCV","SISCOMEX_COST_PLUS_FREIGHT","SISCOMEX_COST_PLUS_INSURANCE"],"type":"string"},"items":{"items":{"additionalProperties":{"$ref":"#/components/schemas/InvoiceItem"},"description":"Items of the Invoice."},"type":"array"},"number":{"description":"The Invoice number.","type":"string"},"total_amount":{"description":"The total amount on the Invoice.","format":"number","type":"string"},"updated_at":{"description":"The timestamp when the Invoice was last updated.","format":"date-time","type":"string"}},"required":["id","number","emitted_at","incoterm","updated_at","total_amount","items"],"title":"Invoice","type":"object"},"SalesOrderItem":{"description":"This schema defines a 'Sales Order Item' (SOI) data structure.","example":{"balance":"10.0","balance_shipped":"10.0","cubage_cubic_meters":null,"dispatch_number":null,"factory_delivery_at":null,"factory_estimated_delivery_at":null,"gross_weight_kg":null,"id":123,"item_status":null,"line_number":1,"line_reference":"1.1","measurement_unit_sap":null,"necessity_type":null,"net_weight_kg":null,"order_currency":{"code":"USD","name":"US Dollar"},"order_item_reference":null,"order_request_number":null,"order_total_value":null,"order_unit_value":null,"order_value":null,"product":{"code":"REF1234","description":"Descrição Produto","id":2,"mercosul_code":"8708.80.00","package_type":"BOTTLES"},"product_description":"Descrição Produto","product_mercosul_code":"8708.80.00","quantity":"20.0","shipment_containers_quantity":null,"shipment_equipment_type":null,"shipment_planned_arrival_at":null,"shipment_planned_boarding_at":null,"supplier_estimated_ready_at":null,"supplier_planned_ready_at":null,"supplier_ready_at":null,"ubc":null},"properties":{"net_weight_kg":{"description":"Net weight in kilograms.","format":"number","nullable":true,"type":"string"},"order_value":{"description":"Order Value.","format":"number","nullable":true,"type":"string"},"order_currency":{"additionalProperties":{"$ref":"#/components/schemas/Currency"},"description":"Information about the currency used for the Invoice."},"line_number":{"description":"The line number associated with this item.","nullable":true,"type":"integer"},"line_reference":{"description":"The line reference associated with this item.","type":"string"},"order_unit_value":{"description":"Order Unit Value.","format":"number","nullable":true,"type":"string"},"shipment_planned_boarding_at":{"description":"Shipment Planned Boarding At.","format":"date-time","nullable":true,"type":"string"},"shipment_equipment_type":{"description":"Shipment Equipment Type.","nullable":true,"type":"string"},"order_item_reference":{"description":"Order Item Reference.","nullable":true,"type":"string"},"factory_estimated_delivery_at":{"description":"Forecast Factory Delivery At.","format":"date-time","nullable":true,"type":"string"},"order_request_number":{"description":"Order Request Number.","nullable":true,"type":"string"},"measurement_unit_sap":{"description":"Measurement unit from SAP.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Sales Order Item.","type":"integer"},"product_translated_descriptions":{"description":"Copy of Translated descriptions related to the product.","nullable":true,"type":"json"},"gross_weight_kg":{"description":"Gross weight in kilograms.","format":"number","nullable":true,"type":"string"},"quantity":{"description":"The quantity of products associated with this item.","format":"number","nullable":true,"type":"string"},"shipment_planned_arrival_at":{"description":"Shipment Planned Arrival At.","format":"date-time","nullable":true,"type":"string"},"product_description":{"description":"Copy of Description of the product.","type":"string"},"supplier_estimated_ready_at":{"description":"Supplier Estimated Readiness At.","format":"date-time","nullable":true,"type":"string"},"product_mercosul_code":{"description":"Copy of Mercosul Code (NCM) of the product.","nullable":true,"type":"string"},"balance":{"description":"The remaining balance of products to be shipped for this item.","format":"number","nullable":true,"type":"string"},"ubc":{"description":"UBC Code","nullable":true,"type":"string"},"dispatch_number":{"description":"The Dispatch number.","nullable":true,"type":"string"},"necessity_type":{"description":"Necessity type","nullable":true,"type":"string"},"balance_shipped":{"description":"The balance of products shipped for this item.","format":"number","nullable":true,"type":"string"},"order_total_value":{"description":"Order Total Value.","format":"number","nullable":true,"type":"string"},"shipment_containers_quantity":{"description":"Shipment Containers Quantity.","format":"number","nullable":true,"type":"string"},"supplier_ready_at":{"description":"Supplier Readiness At.","format":"date-time","nullable":true,"type":"string"},"factory_delivery_at":{"description":"Factory Delivery At.","format":"date-time","nullable":true,"type":"string"},"item_status":{"description":"Item Status","nullable":true,"type":"string"},"product":{"description":"The product linked to this Sales Order Item","properties":{"code":{"description":"SKU of the product.","type":"string"},"description":{"deprecated":true,"description":"Description of the product. (Deprecated - Use product_description)","type":"string"},"id":{"description":"Unique identifier for the Product.","type":"integer"},"mercosul_code":{"deprecated":true,"description":"Mercosul Code (NCM) of the product. (Deprecated - Use product_mercosul_code)","nullable":true,"type":"string"},"package_type":{"description":"Package Type of the product.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"}},"required":["id","code"],"type":"object"},"supplier_planned_ready_at":{"description":"Supplier Planned Readiness At.","format":"date-time","nullable":true,"type":"string"},"cubage_cubic_meters":{"description":"Cubage in cubic meters.","format":"number","nullable":true,"type":"string"}},"required":["id","product","line_reference"],"title":"SalesOrderItem","type":"object"},"PortSchedule":{"description":"This schema defines a 'Port Schedule' data structure.","example":{"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"},"deadweight":500,"dimensions":{"a":124,"b":176,"c":15,"d":33,"length":272,"width":40},"gross_tonnage":300,"id":123,"imo_number":"9743265","mmsi_number":"538006242","name":"NEW ORLEANS","ship_sub_type":"AGGREGATES_CARRIER","ship_type":"ANTI_POLLUTION"},"vessel_responsible":"MASTER"},"properties":{"atb":{"description":"Actual time of berthing for the Port Schedule.","format":"date-time","nullable":true,"type":"string"},"atu":{"description":"Actual time of unberthing for the Port Schedule.","format":"date-time","nullable":true,"type":"string"},"carrier_code":{"description":"Code (CNPJ for Brazilians) of the carrier associated with the Port Schedule.","nullable":true,"type":"string"},"carrier_country":{"additionalProperties":{"$ref":"#/components/schemas/Country"},"description":"Country of the carrier associated with the Port Schedule.","nullable":true},"carrier_name":{"description":"Name of the carrier associated with the Port Schedule.","nullable":true,"type":"string"},"carrier_voyage":{"description":"Voyage information of the carrier associated with the Port Schedule.","nullable":true,"type":"string"},"etb":{"description":"Estimated time of berthing for the Port Schedule.","format":"date-time","nullable":true,"type":"string"},"etu":{"description":"Estimated time of unberthing for the Port Schedule.","format":"date-time","nullable":true,"type":"string"},"last_ports":{"description":"Last ports previously visited by this Vessel.","items":{"properties":{"atu":{"description":"Vessel actual time of unberthing in this port.","format":"date-time","type":"string"},"port_unlocode":{"description":"UN/LOCODE of the port associated with the Port Schedule leg.","type":"string"}},"required":["port_unlocode","atu"],"type":"object"},"type":"array"},"next_ports":{"description":"Next ports to be visited by this Vessel.","items":{"properties":{"etb":{"description":"Vessel estimated time of berthing in this port.","format":"date-time","type":"string"},"port_unlocode":{"description":"UN/LOCODE of the port associated with the Port Schedule leg.","type":"string"}},"required":["port_unlocode","etb"],"type":"object"},"type":"array"},"operation_type":{"description":"Operation type of the vessel in this port.","nullable":true,"type":"string"},"schedule_number":{"description":"Schedule number for the Port Schedule.","type":"string"},"shipping_agency_cnpj":{"description":"CNPJ of the shipping agency associated with the Port Schedule.","nullable":true,"type":"string"},"shipping_agency_name":{"description":"Name of the shipping agency associated with the Port Schedule.","nullable":true,"type":"string"},"vessel":{"additionalProperties":{"$ref":"#/components/schemas/VesselWithDimensions"},"description":"Vessel associated with the Port Schedule."},"vessel_responsible":{"description":"Name of the vessel responsible for the Port Schedule.","nullable":true,"type":"string"}},"required":["schedule_number","last_ports","next_ports","vessel"],"title":"PortSchedule","type":"object"},"CostModelFullObject":{"description":"This schema defines an 'Cost Model' data structure.","example":{"currency":{"code":"USD","name":"US Dollar","symbol":"$"},"has_cost_per_product":false,"has_planned_costs":false,"id":123,"name":"Cost Model"},"properties":{"currency":{"additionalProperties":{"$ref":"#/components/schemas/Currency"},"description":"Information about the currency used for the Cost Model.","nullable":true},"has_cost_per_product":{"description":"If the Cost Model had costs per product.","type":"boolean"},"has_planned_costs":{"description":"If the Cost Model had planned costs.","type":"boolean"},"id":{"description":"Unique identifier for the Cost Model.","type":"integer"},"name":{"description":"Name for the Cost Model.","type":"string"}},"required":["id","name"],"title":"CostModelFullObject","type":"object"},"MaritimePort":{"description":"This schema defines a 'Maritime Port' data structure.","example":{"country":{"code":"BR","iso3":"BRA","name":"Brazil"},"id":123,"latitude":-23.951,"longitude":-46.354,"name":"Santos","unlocode":"BRSSZ"},"properties":{"country":{"additionalProperties":{"$ref":"#/components/schemas/Country"},"description":"The Country where the Port is located.","nullable":true},"id":{"description":"Unique identifier for the Maritime Port.","type":"integer"},"latitude":{"description":"The latitude coordinates of the Port's location.","nullable":true,"type":"number"},"longitude":{"description":"The longitude coordinates of the Port's location.","nullable":true,"type":"number"},"name":{"description":"The name of the Maritime Port.","type":"string"},"unlocode":{"description":"The UN/LOCODE (United Nations Code for Trade and Transport Locations) of the Port.","nullable":true,"type":"string"}},"required":["id","name"],"title":"MaritimePort","type":"object"},"NestedCreateSalesOrderParams":{"description":"Available parameters to create a Sales Order (SO).","example":{"items":[{"cubage_cubic_meters":null,"dispatch_number":null,"factory_delivery_at":null,"factory_estimated_delivery_at":null,"gross_weight_kg":null,"item_status":null,"line_number":1,"line_reference":"1.1","measurement_unit_sap":null,"necessity_type":null,"net_weight_kg":null,"order_currency_code":"USD","order_item_reference":null,"order_request_number":null,"order_unit_value":null,"order_value":null,"product_code":"PRD-123","product_id":1,"quantity":"20.0","shipment_containers_quantity":null,"shipment_equipment_type":null,"shipment_planned_arrival_at":null,"shipment_planned_boarding_at":null,"supplier_estimated_ready_at":null,"supplier_planned_ready_at":null,"supplier_ready_at":null,"ubc":null}],"order_confirmed_at":"2023-10-29T00:00:00Z","order_received_at":"2023-10-29T00:00:00Z","type":"INDIRECT"},"properties":{"items":{"items":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateSalesOrderItemParams"},"description":"Details of the Items associated with this SO."},"type":"array"},"order_confirmed_at":{"description":"Timestamp indicating when the order was confirmed.","format":"date-time","nullable":true,"type":"string"},"order_received_at":{"description":"Timestamp indicating when the order was received.","format":"date-time","nullable":true,"type":"string"},"type":{"description":"Type indicating the type of acquisition of the SO.","enum":["DIRECT","INDIRECT"],"type":"string"}},"required":["type"],"title":"NestedCreateSalesOrderParams","type":"object"},"ProductMutationResponse":{"description":"This schema defines a 'Product Mutation Response' data structure.","properties":{"data":{"properties":{"code":{"description":"Product code.","type":"string"},"id":{"description":"Product ID.","type":"integer"}},"required":["id","code"],"type":"object"}},"title":"ProductMutationResponse","type":"object"},"CreateProcessParams":{"description":"Available parameters to create a Process.","example":{"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_cost_prepaid":"1250.00","freight_forwarder":"ABC Shipping","quotation_number":"Q123456","type":"PREPAID"},"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":[]}],"parcel_shipments":[{"slug":"CourierWidget","tracking_number":"BR1234567890"}],"received_in_warehouse_at":"2023-10-29T00:00:00Z","road_transport_shipment":null,"route_id":1,"shipment_duimps":[{"comments":"","duimp":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","last_updated_at":"2023-11-04T14:30:00Z","number":"21BR00000012345","registered_at":"2023-11-04T10:00:00Z","status":"ADVANCE_DELIVERY_AWAITING_CARGO_DELIVERY","status_updated_at":"2023-11-04T15:45:00Z","version":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.5","total_net_weight":"1.2","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},"handler":{"acquirer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"agent":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"bank":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"bonded_terminal":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"cargo_owner":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"container_depot":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customs_broker":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customs_terminal":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"exporter":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"freight_forwarder":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"funder":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"importer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"integrator":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"international_road_carrier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"manufacturer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"national_road_carrier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"supplier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"trading":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"warehouse":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}]},"handlers":[],"lead_time_datetime_reference":"2023-10-29T00:00:00Z","order_ids":[],"reference_code":"23PRC0000001"}},"properties":{"params":{"properties":{"alert_level":{"default":"NORMAL","description":"Alert level indicating the severity of the Process.","enum":["WARNING","DANGER","NORMAL"],"type":"string"},"brazilian_invoices":{"description":"An array of Brazilian Invoice XML files as Base64.","items":{"type":"string"},"type":"array"},"cost_model_version_id":{"description":"A Cost Model Version associated with this Process.","nullable":true,"type":"integer"},"foreign_trade_shipment":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateForeignTradeShipmentParams"},"description":"A Foreign Trade Shipment associated with this Process.","nullable":true},"handler":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpsertHandlersByRoleParams"},"description":"Handlers responsible for managing this Process by Role."},"handlers":{"deprecated":true,"description":"An array of Handlers responsible for managing this Process.","items":{"$ref":"#/components/schemas/NestedCreateHandlerParams"},"type":"array"},"lead_time_datetime_reference":{"description":"The timestamp serving as the reference point for lead time calculations. Format: ISO 8601 'date-time'.","format":"date-time","nullable":true,"type":"string"},"order_ids":{"description":"An array of Order IDs associated with this Process. As an alternative, you can also use order_reference_codes","items":{"type":"integer"},"type":"array"},"order_reference_codes":{"description":"An array of Order Reference Codes associated with this Process. As an alternative, you can also use order_ids","items":{"type":"string"},"type":"array"},"reference_code":{"description":"A reference code associated with the Process.","nullable":true,"type":"string"}},"type":"object"}},"title":"CreateProcessParams","type":"object"},"NestedShipmentImportDeclarationParams":{"description":"Available parameters to create or update a Shipment Import Declaration.","example":{"comments":"Any 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"}},"properties":{"comments":{"description":"Additional comments or notes related to the Shipment Import Declaration.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Shipment Import Declaration.","type":"integer"},"import_declaration":{"$ref":"#/components/schemas/ImportDeclarationParams"}},"title":"NestedShipmentImportDeclarationParams","type":"object"},"CreatePartnershipParams":{"description":"Parameters to create or update a Partnership and its associated Actor.\n","example":{"params":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company","roles":[{"access_group_id":null,"role":"SUPPLIER"}]}},"properties":{"params":{"$ref":"#/components/schemas/CreateBasePartnershipParams"}},"required":["params"],"title":"CreatePartnershipParams","type":"object"},"UpsertProcessParams":{"description":"List of parameters to Upsert (Update/Create) a Process.","example":{"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_cost_prepaid":"1250.00","freight_forwarder":"ABC Shipping","quotation_number":"Q123456","type":"PREPAID"},"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":[]}],"parcel_shipments":[{"slug":"CourierWidget","tracking_number":"BR1234567890"}],"received_in_warehouse_at":"2023-10-29T00:00:00Z","road_transport_shipment":null,"route_id":1,"shipment_duimps":[{"comments":"","duimp":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","last_updated_at":"2023-11-04T14:30:00Z","number":"21BR00000012345","registered_at":"2023-11-04T10:00:00Z","status":"ADVANCE_DELIVERY_AWAITING_CARGO_DELIVERY","status_updated_at":"2023-11-04T15:45:00Z","version":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.5","total_net_weight":"1.2","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},"handler":{"acquirer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"agent":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"bank":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"bonded_terminal":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"cargo_owner":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"container_depot":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customs_broker":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customs_terminal":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"exporter":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"freight_forwarder":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"funder":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"importer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"integrator":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"international_road_carrier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"manufacturer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"national_road_carrier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"supplier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"trading":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"warehouse":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}]},"handlers":[],"lead_time_datetime_reference":"2023-10-29T00:00:00Z","order_ids":[],"reference_code":"YOUR_REFERENCE_CODE"}]},"properties":{"params":{"items":{"description":"Available parameters to upsert a Process.","properties":{"alert_level":{"default":"NORMAL","description":"Alert level indicating the severity of the Process.","enum":["WARNING","DANGER","NORMAL"],"type":"string"},"brazilian_invoices":{"description":"An array of Brazilian Invoice XML files as Base64.","items":{"type":"string"},"type":"array"},"cost_model_version_id":{"description":"A Cost Model associated with this Process.","nullable":true,"type":"integer"},"foreign_trade_shipment":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateForeignTradeShipmentParams"},"description":"A Foreign Trade Shipment associated with this Process.","nullable":true},"handler":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpsertHandlersByRoleParams"},"description":"Handlers responsible for managing this Process by Role."},"handlers":{"deprecated":true,"description":"An array of Handlers responsible for managing this Process.","items":{"$ref":"#/components/schemas/NestedUpdateHandlerParams"},"type":"array"},"lead_time_datetime_reference":{"description":"The timestamp serving as the reference point for lead time calculations. Format: ISO 8601 'date-time'.","format":"date-time","nullable":true,"type":"string"},"order_ids":{"description":"An array of Order IDs associated with this Process. As an alternative, you can also use order_reference_codes","items":{"type":"integer"},"type":"array"},"order_reference_codes":{"description":"An array of Order Reference Codes associated with this Process. As an alternative, you can also use order_ids","items":{"type":"string"},"type":"array"},"reference_code":{"description":"A reference code of the Process.\nThis is the key used to check whether the process should be updated or created.\n","nullable":false,"type":"string"}},"required":["reference_code"],"type":"object"},"type":"array"}},"title":"UpsertProcessParams","type":"object"},"OrderMutationResponse":{"description":"This schema defines a 'Order Mutation Response' data structure.","properties":{"data":{"properties":{"id":{"description":"Order ID.","type":"integer"},"reference_code":{"description":"Order reference code.","type":"string"}},"required":["id","reference_code"],"type":"object"}},"title":"OrderMutationResponse","type":"object"},"ProcessMutationResponse":{"description":"This schema defines a 'Process Mutation Response' data structure.","properties":{"data":{"properties":{"id":{"description":"Process ID.","type":"integer"},"reference_code":{"description":"Process reference code.","type":"string"}},"required":["id","reference_code"],"type":"object"}},"title":"ProcessMutationResponse","type":"object"},"VesselsResponse":{"description":"An array containing details of multiple vessels.","properties":{"data":{"items":{"$ref":"#/components/schemas/Vessel"},"type":"array"}},"title":"VesselsResponse","type":"object"},"PortTerminal":{"description":"This schema defines a 'Port Terminal' data structure.","example":{"id":123,"name":"Santos Brasil"},"properties":{"id":{"description":"Unique identifier for the Port Terminal.","type":"integer"},"name":{"description":"The name of the Port Terminal.","type":"string"}},"required":["id","name"],"title":"PortTerminal","type":"object"},"NestedCreateNationalRoadTransportParams":{"description":"Available nested parameters to create a National Road Transport.","example":{"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":[{"driver_id":123,"driver_name":"John Doe","phases":[{"departure_at":"2023-10-29T00:00:00Z","estimated_realized_at":"2023-10-29T00:00:00Z","realized_at":"2023-10-29T00:00:00Z","route_point_id":1},{"departure_at":"2023-10-29T00:00:00Z","estimated_realized_at":"2023-10-29T00:00:00Z","realized_at":"2023-10-29T00:00:00Z","route_point_id":2}],"position":123,"trailer_plate":"XYZ456","transportable_ids":[123,124],"vehicle_id":123,"vehicle_plate":"ABC123"}]},"properties":{"collection_scheduled_at":{"description":"Scheduled timestamp for Cargo.","format":"date-time","nullable":true,"type":"string"},"delivery_planned_at":{"description":"Planned delivery timestamp.","format":"date-time","nullable":true,"type":"string"},"is_transport_type_dta":{"default":false,"description":"Indicates whether the transport type is 'dta'.","type":"boolean"},"leg_slug":{"description":"Identifier for the National Road Transport leg.","type":"string"},"load_type":{"description":"Type of Cargo the National Road Transport is designed for.","enum":["GENERAL_CARGO","FOOD","PHARMACEUTICALS","WEAPONS","BULK"],"nullable":true,"type":"string"},"national_road_carrier":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateHandlerParams"},"description":"Information about the Road Carrier."},"quantity_pallets":{"description":"The quantity of pallets used in the National Road Transport.","nullable":true,"type":"integer"},"released_for_transport_at":{"description":"The timestamp when the Cargo is released for Transport.","format":"date-time","nullable":true,"type":"string"},"road_transport_type":{"description":"Type of National Road Transport.","enum":["LTL","FTL","FCL","BULK_CARGO"],"nullable":true,"type":"string"},"route_id":{"description":"Unique identifier for the Route.","nullable":true,"type":"integer"},"transport_completed_at":{"description":"The timestamp when the National Road Transport is completed.","format":"date-time","nullable":true,"type":"string"},"transport_features":{"items":{"description":"Special features associated with the National Road Transport.","enum":["REFRIGERATED","HAZARDOUS_PRODUCTS"],"type":"string"},"nullable":true,"type":"array"},"trips":{"items":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateRoadTransportTripParams"},"description":"Details of the Trip associated with this National Road Transport."},"type":"array"}},"required":["leg_slug"],"title":"NestedCreateNationalRoadTransportParams","type":"object"},"UpdateProductParams":{"description":"Available parameters to update a Product.","example":{"params":{"multiple_package_per_container_ft20":500,"category":"Suspension","package_measurement_unit":"PAIRS","extra":null,"package_capacity":"4","multiple_package_type":"BOXES","family":"Suspension and Handling","pallets_per_container_ft40":20,"code":"REF1234","translated_descriptions":null,"manufacturer":"Schneider-Rutherford","multiple_package_measurement_unit":"BOXES","description":"Shock Absorbers","pallets_per_container_ft20":10,"package_code":"PR017","content_type":"PAIRS","content_capacity":"1.0","content_measurement_unit":"BOXES","packages_per_container_ft20":1000,"additional_details":null,"multiple_code":"REF1234","cubage_per_package":"0.03","gross_weight_per_package":"10.5","packages_per_pallet":50,"mercosul_code":"8708.80.00","dumping":false,"packages_per_container_ft40":2000,"internal_codes":[{"code":"REF5678","label":"Client internal code"},{"code":"CODE-2","label":"Supplier code"}],"net_weight_per_package":"9.8","product_foreign_operators":[],"multiple_package_per_container_ft40":1000,"multiple_package_capacity":"30","content_code":"REF1234"}},"properties":{"multiple_package_per_container_ft20":{"description":"Estimated number of packages fitting by volume (cubage) in a 20ft container.","nullable":true,"type":"integer"},"category":{"description":"Category of the product.","nullable":true,"type":"string"},"package_measurement_unit":{"description":"Package Measurement Unit of the product.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"extra":{"description":"Extra information related to the product.","nullable":true,"type":"json"},"package_capacity":{"description":"Package capacity of the product.","format":"decimal","nullable":true,"type":"string"},"multiple_package_type":{"description":"Type of the multi-package unit (e.g. box, pallet, bag).","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"family":{"description":"Family of the product.","nullable":true,"type":"string"},"pallets_per_container_ft40":{"description":"Estimated number of pallets that fit into a 40ft container.","type":"integer"},"has_unitization":{"description":"If Product has Unitization","nullable":true,"type":"boolean"},"code":{"description":"Code (SKU) of the product.","type":"string"},"translated_descriptions":{"description":"Translated descriptions related to the product.","nullable":true,"type":"json"},"manufacturer":{"description":"Manufacturer of the product.","nullable":true,"type":"string"},"multiple_package_measurement_unit":{"description":"Multiple Package Measurement Unit of the product.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"has_containerization":{"description":"If Product has Containerization","nullable":true,"type":"boolean"},"package_type":{"description":"Package Type of the product.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"description":{"description":"Description of the product.","type":"string"},"pallets_per_container_ft20":{"description":"Estimated number of pallets that fit into a 20ft container.","nullable":true,"type":"integer"},"package_code":{"description":"Package code of the product.","nullable":true,"type":"string"},"content_type":{"description":"Measurement unit type for the package contents (e.g. kg, liter, unit).","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"has_palletization":{"description":"If Product has Palletization","nullable":true,"type":"boolean"},"content_capacity":{"description":"The capacity value (e.g. 1.5 for 1.5L or 1.5kg) of the content per package.","format":"decimal","nullable":true,"type":"string"},"content_measurement_unit":{"description":"Unit used to quantify the product content.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"packages_per_container_ft20":{"description":"Estimated number of packages that fit into a 20ft container.","nullable":true,"type":"integer"},"additional_details":{"description":"Additional details of the product.","nullable":true,"type":"string"},"multiple_code":{"description":"Code identifying the multi-package configuration.","nullable":true,"type":"string"},"cubage_per_package":{"description":"Cubage (volume) per package, in cubic meters.","format":"decimal","nullable":true,"type":"string"},"has_content":{"description":"If Product has Content","nullable":true,"type":"boolean"},"gross_weight_per_package":{"description":"Gross weight per individual package, including packaging material.","format":"decimal","nullable":true,"type":"string"},"packages_per_pallet":{"description":"Total number of packages that fit on a standard pallet.","nullable":true,"type":"integer"},"mercosul_code":{"description":"Mercosul Code (NCM) of the product.","nullable":true,"type":"string"},"dumping":{"description":"If Product is subject to dumping","nullable":true,"type":"boolean"},"packages_per_container_ft40":{"description":"Estimated number of packages that fit into a 40ft container.","nullable":true,"type":"integer"},"internal_codes":{"description":"An array of internal codes of this product.","items":{"properties":{"code":{"description":"Code for the Internal Code.","type":"string"},"label":{"description":"Label for the Internal Code.","type":"string"}},"type":"object"},"type":"array"},"net_weight_per_package":{"description":"Net weight per individual package, excluding packaging material.","format":"decimal","nullable":true,"type":"string"},"product_foreign_operators":{"description":"An array of Actor IDs to be associated as foreign operators for the product","items":{"type":"integer"},"type":"array"},"multiple_package_per_container_ft40":{"description":"Estimated number of packages fitting by volume (cubage) in a 40ft container.","nullable":true,"type":"integer"},"multiple_package_capacity":{"description":"Multiple package capacity of the product.","format":"decimal","nullable":true,"type":"string"},"content_code":{"description":"Internal or external code identifying the product content type.","nullable":true,"type":"string"}},"title":"UpdateProductParams","type":"object"},"NationalRoadTransport":{"description":"This schema defines a 'National Road Transport' data structure.","example":{"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","national_road_carrier":{"actor":{"cnae":"","contact_details":"Contact Details","description":"Description","document_type":"CNPJ","id":1,"internal_code":"123123","logo_url":null,"nickname":"Nickname","official_document":"11111111111111","official_name":"Actor","opening_date":"2023-01-01","roles":[{"access_group":{"slug":"access_group"},"role":"CARGO_OWNER"}],"trading_name":"Trading Name","verified":true},"business_unit":"Business Unit","id":1,"operation_handler":{"id":1,"role":"CARGO_OWNER"},"reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"},"quantity_pallets":100,"released_for_transport_at":"2023-10-29T00:00:00Z","road_transport_type":"LTL","route":{"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"}]},"properties":{"collection_scheduled_at":{"description":"Scheduled timestamp for Cargo.","format":"date-time","nullable":true,"type":"string"},"delivery_planned_at":{"description":"Planned delivery timestamp.","format":"date-time","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the National Road Transport.","type":"integer"},"is_transport_type_dta":{"default":false,"description":"Indicates whether the transport type is 'dta'.","type":"boolean"},"leg_slug":{"description":"Identifier for the National Road Transport leg.","type":"string"},"load_type":{"description":"Type of Cargo the National Road Transport is designed for.","enum":["GENERAL_CARGO","FOOD","PHARMACEUTICALS","WEAPONS","BULK"],"nullable":true,"type":"string"},"national_road_carrier":{"additionalProperties":{"$ref":"#/components/schemas/Handler"},"description":"Information about the Road Carrier."},"quantity_pallets":{"description":"The quantity of pallets used in the National Road Transport.","nullable":true,"type":"integer"},"released_for_transport_at":{"description":"The timestamp when the Cargo is released for Transport.","format":"date-time","nullable":true,"type":"string"},"road_transport_type":{"description":"Type of National Road Transport.","enum":["LTL","FTL","FCL","BULK_CARGO"],"nullable":true,"type":"string"},"route":{"additionalProperties":{"$ref":"#/components/schemas/RouteMinimalObject"},"description":"Details of the route associated with this National Road Transport.","nullable":true},"transport_completed_at":{"description":"The timestamp when the National Road Transport is completed.","format":"date-time","nullable":true,"type":"string"},"transport_features":{"items":{"description":"Special features associated with the National Road Transport.","enum":["REFRIGERATED","HAZARDOUS_PRODUCTS"],"type":"string"},"type":"array"},"trips":{"items":{"additionalProperties":{"$ref":"#/components/schemas/RoadTransportTrip"},"description":"Details of the Trip associated with this National Road Transport."},"type":"array"}},"required":["id","leg_slug","is_transport_type_dta","transport_features"],"title":"NationalRoadTransport","type":"object"},"CeMercanteData":{"description":"This schema defines an 'CeMercanteData' data structure.","example":{"bl":null,"cargo_description":null,"cargo_manifests":[{"discharge_port_terminal":null,"discharge_port_unlocode":"BRSSZ","loading_port_terminal":null,"loading_port_unlocode":"BRRIO","manifest_number":"1234"}],"cargo_presence_at":null,"cargo_presence_history":[{"date":"2024-07-04T00:00:00Z","dta_number":null,"ra":"0403201","status":"ARMAZENADA","synced_at":"2024-07-05T10:00:00Z"}],"cargo_presence_in_primary_zone_at":null,"cargo_presence_in_secondary_zone_at":null,"cargo_status":null,"consignee_document":null,"consignee_extra_info":null,"container_seals":[{"container_code":"TGHU1234567","seal_code":"SF1234","secondary_seal_code":null}],"customs_place":null,"destination_port":{"country":{"code":"BR","iso3":"BRA","name":"Brazil"},"id":123,"latitude":-23.951,"longitude":-46.354,"name":"Santos","unlocode":"BRSSZ"},"di_number":null,"dta_number":null,"final_destination_arrival_at":null,"freight_basic_cost":null,"freight_currency":{"code":"USD","name":"US Dollar","symbol":"$"},"freight_payment_type":null,"freight_total_cost":null,"gross_weight_kg":null,"has_dta":false,"id":1,"issued_at":null,"last_updated_at":null,"manifest_arrival_at":null,"notes":null,"number":"123","origin_port":{"country":{"code":"BR","iso3":"BRA","name":"Brazil"},"id":123,"latitude":-23.951,"longitude":-46.354,"name":"Santos","unlocode":"BRSSZ"},"shipping_agency":{"cnae":"","contact_details":"Contact Details","description":"Description","document_type":"CNPJ","id":1,"internal_code":"123123","logo_url":null,"nickname":"Nickname","official_document":"11111111111111","official_name":"Actor","opening_date":"2023-01-01","roles":[{"access_group":{"slug":"access_group"},"role":"CARGO_OWNER"}],"trading_name":"Trading Name","verified":true},"status_response":"PENDING"},"properties":{"bl":{"description":"The BL of the CE Mercante.","type":"string"},"cargo_description":{"description":"The cargo description of the CE Mercante.","type":"string"},"cargo_manifests":{"description":"The cargo manifests of the CE Mercante.","items":{"$ref":"#/components/schemas/CeMercanteDataCargoManifest"},"type":"array"},"cargo_presence_at":{"deprecated":true,"description":"Deprecated. Alias for cargo_presence_in_primary_zone_at.","format":"date-time","nullable":true,"type":"string"},"cargo_presence_history":{"description":"The full history of cargo status and RA changes.","items":{"$ref":"#/components/schemas/CeMercanteDataCargoPresenceHistory"},"type":"array"},"cargo_presence_in_primary_zone_at":{"description":"The date when cargo arrived at primary zone (port), derived from dataSituacaoCarga when status is ARMAZENADA without DTA.","format":"date-time","nullable":true,"type":"string"},"cargo_presence_in_secondary_zone_at":{"description":"The date when cargo arrived at secondary zone (EADI), derived from dataSituacaoCarga when status is ARMAZENADA with DTA.","format":"date-time","nullable":true,"type":"string"},"cargo_status":{"description":"The cargo status of the CE Mercante.","type":"string"},"consignee_document":{"description":"The consignee document of the CE Mercante.","type":"string"},"consignee_extra_info":{"description":"The consignee extra info of the CE Mercante.","type":"string"},"container_seals":{"description":"The container seals extracted from the CE Mercante items endpoint.","items":{"$ref":"#/components/schemas/CeMercanteDataContainerSeal"},"type":"array"},"customs_place":{"description":"The customs place of the CE Mercante.","type":"string"},"destination_port":{"additionalProperties":{"$ref":"#/components/schemas/MaritimePort"},"description":"The destination port of the CE Mercante.","nullable":true},"di_number":{"description":"The DI number of the CE Mercante.","type":"string"},"dta_number":{"description":"The DTA number of the CE Mercante.","type":"string"},"final_destination_arrival_at":{"description":"The final destination arrival date of the CE Mercante.","format":"date-time","type":"string"},"freight_basic_cost":{"description":"The freight basic cost of the CE Mercante.","format":"number","nullable":true,"type":"string"},"freight_currency":{"additionalProperties":{"$ref":"#/components/schemas/Currency"},"description":"The freight currency of the CE Mercante."},"freight_payment_type":{"description":"The freight payment type of the CE Mercante.","type":"string"},"freight_total_cost":{"description":"The freight total cost of the CE Mercante.","format":"number","nullable":true,"type":"string"},"gross_weight_kg":{"description":"The gross weight of the CE Mercante.","format":"number","nullable":true,"type":"string"},"has_dta":{"description":"Whether the CE Mercante has a DTA document.","type":"boolean"},"id":{"description":"The unique identifier for the CE Mercante.","type":"integer"},"issued_at":{"description":"The issued date of the CE Mercante.","format":"date-time","type":"string"},"last_updated_at":{"description":"The timestamp when the CE Mercante was last updated.","format":"date-time","type":"string"},"manifest_arrival_at":{"description":"The arrival date from the manifest (dataOperacao).","format":"date-time","type":"string"},"notes":{"description":"The notes of the CE Mercante.","type":"string"},"number":{"description":"The number of the CE Mercante.","nullable":false,"type":"string"},"origin_port":{"additionalProperties":{"$ref":"#/components/schemas/MaritimePort"},"description":"The origin port of the CE Mercante.","nullable":true},"shipping_agency":{"additionalProperties":{"$ref":"#/components/schemas/Actor"},"description":"The shipping agency of the CE Mercante."},"status_response":{"default":"PENDING","description":"The response status of the CE Mercante.","enum":["PENDING","NOT_FOUND","FOUND","INVALID"],"type":"string"}},"required":["id","number"],"title":"CeMercanteData","type":"object"},"NestedUpdateRoadTransportShipmentParams":{"description":"Available nested parameters to update a Foreign Trade Road Transport Shipment.","example":{"crt":"CRT2024001","destination":"Buenos Aires, Argentina","origin":"São Paulo, Brasil","type":"FTL"},"properties":{"crt":{"description":"CRT associated with the Shipment.","nullable":true,"type":"string"},"destination":{"description":"The destination of the Shipment.","nullable":true,"type":"string"},"origin":{"description":"The origin of the Shipment.","nullable":true,"type":"string"},"type":{"description":"Type of the Road Transport Shipment","enum":["FCL","FTL","LTL"],"nullable":true,"type":"string"}},"title":"NestedUpdateRoadTransportShipmentParams","type":"object"},"Process":{"description":"This schema defines a 'Process' data structure.","example":{"alert_level":"NORMAL","canceled_at":null,"cost_model_version":null,"deleted_at":null,"documents":[{"description":"The description of Document","external_id":"1234","id":1,"original_filename":"shipment_document.pdf","type":"SHIPMENT_DOCUMENT"}],"extra_fields":{},"finished_at":null,"foreign_trade_shipment":{"road_transport_shipment":null,"etd":"2023-10-29T00:00:00Z","received_in_warehouse_at":"2023-10-29T00:00:00Z","inserted_at":"2023-01-01T00:00:00Z","hawb_shipment_data":{"airline":{"callsign":"AMERICAN","hub_code":"DFW","iata_code":"AA","icao_code":"AAL","id":1,"name":"American Airlines"},"arrival_place_dta":"Warehouse B","ata":"2023-04-02T14:30:00Z","ata_dta":"2023-04-03T11:00:00Z","atd":"2023-04-01T10:15:00Z","atd_dta":"2023-04-03T09:00:00Z","departure_place_dta":"Airport A","di_number":"DI987654","dta_number":"DTA123456","eta":"2023-04-02T14:00:00Z","etd":"2023-04-01T10:00:00Z","extra":{},"flight":"AA123","hawb":"123-45678901","id":1,"loading_airport":{"city_iata_code":"SAO","iata_code":"GRU","icao_code":"SBGR","id":2736,"latitude":-22.816668,"longitude":-45.216667,"name":"Aeroporto Internacional Guarulhos","timezone":"America/Sao_Paulo"},"status":"In Transit","stopovers":1,"unloading_airport":{"city_iata_code":"SAO","iata_code":"GRU","icao_code":"SBGR","id":2736,"latitude":-22.816668,"longitude":-45.216667,"name":"Aeroporto Internacional Guarulhos","timezone":"America/Sao_Paulo"},"vehicle_plate_dta":"ABC1234"},"international_transport_legs":[{"arrival_place":"DEHAM","ata":"2024-07-05T21:00:00Z","atd":"2024-06-20T13:00:00Z","departure_place":"SGSIN","eta":"2024-07-05T20:00:00Z","etd":"2024-06-20T12:00:00Z","modal_type":"MARITIME","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":"VY7531"}],"parcel_shipments":[{"ata":null,"atd":"2023-05-15T10:15:00Z","courier":{"code":"COR","id":1,"name":"Correios"},"destination_address":"Av. B, 456, São Paulo, SP, Brasil","destination_country_code":"BR","eta":"2023-05-20T12:00:00Z","etd":"2023-05-15T10:00:00Z","id":1,"origin_address":"Rua A, 123, Rio de Janeiro, RJ, Brasil","origin_country_code":"BR","slug":"CourierWidget","tracking_number":"BR1234567890"}],"shipment_export_declarations":[{"comments":"","export_declaration":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","id":1,"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"},"id":1}],"type":"MARITIME_TRANSPORT","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","national_road_carrier":{"actor":{"cnae":"","contact_details":"Contact Details","description":"Description","document_type":"CNPJ","id":1,"internal_code":"123123","logo_url":null,"nickname":"Nickname","official_document":"11111111111111","official_name":"Actor","opening_date":"2023-01-01","roles":[{"access_group":{"slug":"access_group"},"role":"CARGO_OWNER"}],"trading_name":"Trading Name","verified":true},"business_unit":"Business Unit","id":1,"operation_handler":{"id":1,"role":"CARGO_OWNER"},"reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"},"quantity_pallets":100,"released_for_transport_at":"2023-10-29T00:00:00Z","road_transport_type":"LTL","route":{"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"}]}],"invoices":[{"currency":{"code":"USD","name":"US Dollar","symbol":"$"},"discount":"34.56","emitted_at":"2023-11-04T10:00:00Z","final_value":"1200.00","id":1,"incoterm":"CPT","items":[{"batch_number":"BATCH-6789","batch_validity_date":"2024-10-29T00:00:00Z","id":1,"order_item_line_reference":"1","order_reference_code":"ORC-123","product_description":"Product A","product_sku":"SKU-12345","production_date":"2023-10-29T00:00:00Z","quantity":"5","shipment_quantity":5,"total_amount":"61.70","total_gross_weight_kg":"80.00","unitary_amount":"12.34"}],"number":"INV-2023-001","total_amount":"1234.56","updated_at":"2023-11-04T14:30:00Z"}],"shipment_import_declarations":[{"comments":"","id":1,"import_declaration":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","id":1,"import_licenses":[{"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"}],"items":[{"brazilian_invoice_unit_value":"10","cubage_cubic_meters":null,"gross_weight_kg":null,"id":123,"net_weight_kg":"0.5","purchase_order_item":{"net_weight_kg":null,"order_value":null,"shipment_estimated_boarding_at":null,"supplier_confirmation_at":null,"shipment_boarding_lead_time":null,"order_currency":{"code":"USD","name":"US Dollar"},"line_number":1,"line_reference":"1.1","customs_release_lead_time":null,"order_unit_value":null,"shipment_estimated_arrival_at":null,"import_type_sap":null,"manufacturing_country":{"code":"BR","name":"Brazil"},"shipment_planned_boarding_at":null,"sap_by_factor":null,"order_modal_type_sap":null,"shipping_details_delivery_date":null,"shipment_equipment_type":null,"order_item_reference":null,"dispatching_country":{"code":"BR","name":"Brazil"},"factory_estimated_delivery_at":null,"delivery_note":null,"factory_delivery_lead_time":null,"adjusted_factory_delivery_lead_time":null,"assessment_sotd":null,"planning_request_shipping_at":null,"order_adjusted_modal_type":null,"order_request_number":null,"concession_act":null,"customs_estimated_release_at":null,"quotation_opening_date":null,"adjusted_customs_release_lead_time":null,"measurement_unit_sap":null,"shipment_transport_lead_time":null,"id":123,"order_requested_at":null,"delivery_note_issued_at":null,"gross_weight_kg":null,"purchase_country":{"code":"BR","name":"Brazil"},"supplier_ready_lead_time_days":null,"quantity":"20.0","invoice_issued_at":null,"shipment_planned_arrival_at":null,"product_description":"Descrição Produto","supplier_estimated_ready_at":null,"invoice_value":null,"product_mercosul_code":"8708.80.00","customs_register_lead_time":null,"adjusted_shipment_transport_lead_time":null,"planning_shipping_at":null,"balance":"10.0","order":{"id":2,"reference_code":"REF-2"},"invoice_number":null,"adjusted_customs_register_lead_time":null,"customs_estimated_register_at":null,"balance_shipped":"10.0","order_total_value":null,"shipment_containers_quantity":null,"supplier_sent_at":null,"supplier_ready_at":null,"factory_delivery_at":null,"factory_planned_delivery_at":null,"invoice_type":null,"adjusted_shipment_boarding_lead_time":null,"item_status":null,"product":{"code":"REF1234","description":"Descrição Produto","id":2,"mercosul_code":"8708.80.00","package_type":"BOTTLES"},"adjusted_supplier_ready_lead_time_days":null,"supplier_planned_ready_at":null,"supplier_calculated_ready_at":null,"cubage_cubic_meters":null},"quantity":"10","sales_order_item":null,"total_value":"100","unit_value":"10"}],"ce_mercante_number":null,"ata":"2023-10-29T00:00:00Z","empty_return_date":"2023-10-29T00:00:00Z","eta":"2023-10-29T00:00:00Z","automatic_tracking_enabled":true,"total_net_weight":"1.7","days_in_warehouse":2,"id":123,"ce_mercante_data":{"bl":null,"cargo_description":null,"cargo_manifests":[{"discharge_port_terminal":null,"discharge_port_unlocode":"BRSSZ","loading_port_terminal":null,"loading_port_unlocode":"BRRIO","manifest_number":"1234"}],"cargo_presence_at":null,"cargo_presence_history":[{"date":"2024-07-04T00:00:00Z","dta_number":null,"ra":"0403201","status":"ARMAZENADA","synced_at":"2024-07-05T10:00:00Z"}],"cargo_presence_in_primary_zone_at":null,"cargo_presence_in_secondary_zone_at":null,"cargo_status":null,"consignee_document":null,"consignee_extra_info":null,"container_seals":[{"container_code":"TGHU1234567","seal_code":"SF1234","secondary_seal_code":null}],"customs_place":null,"destination_port":{"country":{"code":"BR","iso3":"BRA","name":"Brazil"},"id":123,"latitude":-23.951,"longitude":-46.354,"name":"Santos","unlocode":"BRSSZ"},"di_number":null,"dta_number":null,"final_destination_arrival_at":null,"freight_basic_cost":null,"freight_currency":{"code":"USD","name":"US Dollar","symbol":"$"},"freight_payment_type":null,"freight_total_cost":null,"gross_weight_kg":null,"has_dta":false,"id":1,"issued_at":null,"last_updated_at":null,"manifest_arrival_at":null,"notes":null,"number":"123","origin_port":{"country":{"code":"BR","iso3":"BRA","name":"Brazil"},"id":123,"latitude":-23.951,"longitude":-46.354,"name":"Santos","unlocode":"BRSSZ"},"shipping_agency":{"cnae":"","contact_details":"Contact Details","description":"Description","document_type":"CNPJ","id":1,"internal_code":"123123","logo_url":null,"nickname":"Nickname","official_document":"11111111111111","official_name":"Actor","opening_date":"2023-01-01","roles":[{"access_group":{"slug":"access_group"},"role":"CARGO_OWNER"}],"trading_name":"Trading Name","verified":true},"status_response":"PENDING"},"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"}],"shipment_duimps":[{"comments":"","duimp":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","id":1,"inserted_at":"2023-11-04T09:30:00Z","last_updated_at":"2023-11-04T14:30:00Z","number":"21BR00000012345","registered_at":"2023-11-04T10:00:00Z","status":"ADVANCE_DELIVERY_AWAITING_CARGO_DELIVERY","status_response":"FOUND","version":1},"id":1}],"transportables":[{"cargo":null,"container":{"actual_return_empty_container_at":"2023-01-01T00:00:00Z","code":"MSDU5953962","cubic_meters":30.0,"demurrage_free_time_start_at":"2023-01-01T00:00:00Z","dispatch_number":"DISP12345","estimated_return_empty_container_at":"2023-01-01T00:00:00Z","events":[{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"CNXIS","status":"Empty to Shipper","transport":null,"voyage":"CNXISTRB"},{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"CNNGB","status":"Export received at CY","transport":null,"voyage":"CNNGBTRB"},{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"CNNGB","status":"Export Loaded on Vessel","transport":"9484455","voyage":"CNNGBUX333A"},{"datetime":"2023-01-01T00:00:00Z","estimated":false,"place":"DOCAU","status":"Full Transshipment Discharged","transport":"9484455","voyage":"DOCAUUX338R"},{"datetime":"2023-01-01T00: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","is_stackable":true,"load_type":"GENERAL_CARGO","max_weight_kg":"100.123","observations":"observation example","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,"transport_document":"TDOC67890","type":"DRY"},"id":123,"type":"CONTAINER"}],"international_freight":{"booking_discharge_airport":{"city_iata_code":"SAO","iata_code":"GRU","icao_code":"SBGR","id":2736,"latitude":-22.816668,"longitude":-45.216667,"name":"Aeroporto Internacional Guarulhos","timezone":"America/Sao_Paulo"},"booking_discharge_port":{"country":{"code":"BR","iso3":"BRA","name":"Brazil"},"id":123,"latitude":-23.951,"longitude":-46.354,"name":"Santos","unlocode":"BRSSZ"},"booking_eta":"2023-10-29T00:00:00Z","booking_etd":"2023-10-29T00:00:00Z","booking_loading_airport":{"city_iata_code":"SAO","iata_code":"GRU","icao_code":"SBGR","id":2736,"latitude":-22.816668,"longitude":-45.216667,"name":"Aeroporto Internacional Guarulhos","timezone":"America/Sao_Paulo"},"booking_loading_port":{"country":{"code":"BR","iso3":"BRA","name":"Brazil"},"id":123,"latitude":-23.951,"longitude":-46.354,"name":"Santos","unlocode":"BRSSZ"},"cargo_attributes":["REEFER"],"currency":{"code":"USD","name":"US Dollar","symbol":"$"},"freight_cost_collect":"1250.00","freight_cost_prepaid":"1250.00","freight_cost_road":null,"freight_cost_total":"2500.00","freight_forwarder":"ABC Shipping","id":1,"planned_boarding_date":"2023-10-29T00:00:00Z","port_terminal":{"id":123,"name":"Santos Brasil"},"quotation_number":"Q123456","sealine":{"id":1,"nickname":"Maersk","scac":"MAEU"},"type":"PREPAID","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":"123A"},"total_gross_weight":"2.0","demurrage":{"daily_rate_usd":"10.5","free_time":2,"id":1},"days_left_in_warehouse":1,"air_transport_shipment":null,"status_response":"FOUND","atd":"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,"nickname":"Maersk","scac":"MAEU"},"tracking_discharge_port":"BRRIG","tracking_key":"BILL_OF_LADING","tracking_loading_port":"CNNGB","tracking_number":null,"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"},"warehouse_free_time_days":1,"route":{"active":true,"id":123,"name":"Route A","points":[{"id":123,"position":1,"route_type":"LOADING"}]},"delivered_at":"2023-10-29T00:00:00Z","last_tracking_at":"2023-10-29T00:00:00Z","departed_from_warehouse_at":"2023-10-29T00:00:00Z","cubage_cubic_meters":"1.5"},"handlers":[{"actor":{"cnae":"","contact_details":"Contact Details","description":"Description","document_type":"CNPJ","id":1,"internal_code":"123123","logo_url":null,"nickname":"Nickname","official_document":"11111111111111","official_name":"Actor","opening_date":"2023-01-01","roles":[{"access_group":{"slug":"access_group"},"role":"CARGO_OWNER"}],"trading_name":"Trading Name","verified":true},"business_unit":"Business Unit","id":1,"operation_handler":{"id":1,"role":"CARGO_OWNER"},"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","operation":{"id":1},"orders":[{"id":1,"reference_code":"REF-1"},{"id":2,"reference_code":"REF-2"}],"reference_code":"23PRC0000001"},"properties":{"alert_level":{"default":"NORMAL","description":"Alert level indicating the severity of the Process.","enum":["WARNING","DANGER","NORMAL"],"type":"string"},"canceled_at":{"description":"The timestamp indicating when the process was canceled. Format: ISO 8601 'date-time'.","format":"date-time","nullable":true,"type":"string"},"cost_model_version":{"additionalProperties":{"$ref":"#/components/schemas/CostModelVersionMinimalObject"},"description":"A Cost Model Version associated with this Process.","nullable":true},"deleted_at":{"description":"The timestamp indicating when the process was deleted. Format: ISO 8601 'date-time'.","format":"date-time","nullable":true,"type":"string"},"documents":{"additionalProperties":{"$ref":"#/components/schemas/Document"},"description":"Documents associated with this Process.","type":"array"},"finished_at":{"description":"The timestamp indicating when the process was finished. Format: ISO 8601 'date-time'.","format":"date-time","nullable":true,"type":"string"},"foreign_trade_shipment":{"additionalProperties":{"$ref":"#/components/schemas/ForeignTradeShipment"},"description":"A Foreign Trade Shipment associated with this Process.","nullable":true},"handlers":{"description":"An array of Handlers responsible for managing this Process.","items":{"$ref":"#/components/schemas/Handler"},"type":"array"},"id":{"description":"Unique identifier for the Process.","type":"integer"},"inserted_at":{"description":"The timestamp indicating when the process was inserted. Format: ISO 8601 'date-time'.","format":"date-time","type":"string"},"lead_time_datetime_reference":{"description":"The timestamp serving as the reference point for lead time calculations. Format: ISO 8601 'date-time'.","format":"date-time","nullable":true,"type":"string"},"operation":{"properties":{"id":{"description":"Unique identifier for the Operation","type":"integer"}},"required":["id"],"type":"object"},"orders":{"description":"An array of Orders associated with this Process.","items":{"properties":{"id":{"description":"Unique identifier for the Order.","type":"integer"},"reference_code":{"description":"A reference code associated with the Order.","type":"string"}},"type":"object"},"type":"array"},"reference_code":{"description":"A reference code associated with the Process.","type":"string"}},"required":["id","operation","alert_level","reference_code","inserted_at"],"title":"Process","type":"object"},"UpsertPartnershipHandlerParams":{"description":"Parameters to upsert a Partnership and its associated Actor in Handler Structure.\n","example":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company","roles":[{"access_group_id":null,"role":"SUPPLIER"}]},"properties":{"contact_details":{"description":"Contact details of the Partnership.","nullable":true,"type":"string"},"description":{"description":"Description of the Partnership.","nullable":true,"type":"string"},"document_type":{"description":"The type of official document. Must be provided along with official_document.","enum":["CNPJ","CPF","TIN","INTERNAL_CODE"],"type":"string"},"internal_code":{"description":"Internal code of the Partnership. As an alternative you can use official_document + document_type to create a partnership.","type":"string"},"name":{"description":"Name/nickname of the Actor.","type":"string"},"official_document":{"description":"The official document that identifies the actor.","type":"string"},"roles":{"description":"List of roles that the Actor will have in the Partnership.","items":{"properties":{"access_group_id":{"description":"The access group associated with this role. Optional.","nullable":true,"type":"integer"},"role":{"description":"The role/function of the actor in the partnership.","enum":["ACQUIRER","AGENT","BANK","BONDED_TERMINAL","CARGO_OWNER","CONTAINER_DEPOT","CUSTOMER","CUSTOMS_BROKER","CUSTOMS_TERMINAL","EXPORTER","FUNDER","FREIGHT_FORWARDER","IMPORTER","INTEGRATOR","INTERNATIONAL_ROAD_CARRIER","MANUFACTURER","NATIONAL_ROAD_CARRIER","SUPPLIER","TRADING","WAREHOUSE"],"type":"string"}},"required":["role"],"type":"object"},"nullable":true,"type":"array"}},"required":["name"],"title":"UpsertPartnershipHandlerParams","type":"object"},"ImportDeclarationParams":{"description":"Available parameters to create or update an Import Declaration.","example":{"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"},"properties":{"channel":{"description":"The Import Declaration channel.","enum":["GREEN","RED","YELLOW","GRAY"],"nullable":true,"type":"string"},"customs_cleared_at":{"description":"The timestamp when the Import Declaration was customs cleared.","format":"date-time","nullable":true,"type":"string"},"extra":{"description":"Additional information related to the Import Declaration.","nullable":true,"type":"object"},"last_updated_at":{"description":"The timestamp when the Import Declaration was last updated.","format":"date-time","nullable":true,"type":"string"},"number":{"description":"The Import Declaration number.","type":"string"},"registered_at":{"description":"The timestamp when the Import Declaration was registered.","format":"date-time","nullable":true,"type":"string"},"status":{"description":"The current status of the Import Declaration.","enum":["WAITING_PARAMETERIZATION","WAITING_DOCUMENT","WAITING_DISTRIBUTION","WAITING_FISCAL_ANALYSIS","READY_DISTRIBUTION","UNDER_FISCAL_ANALYSIS","DISPATCH_INTERRUPTED","DELIVERY_AUTHORIZED","CLEARED","CANCELLED","WAITING_CLEARANCE","NOT_REPORTED","IN_FORFEITURE"],"nullable":true,"type":"string"},"status_updated_at":{"description":"The timestamp when the status of the Import Declaration was last updated.","format":"date-time","nullable":true,"type":"string"}},"title":"ImportDeclarationParams","type":"object"},"UpdateSalesOrderItemParams":{"description":"Available parameters to update a Sales Order Item.","properties":{"params":{"properties":{"cubage_cubic_meters":{"description":"Cubage in cubic meters.","format":"number","nullable":true,"type":"string"},"dispatch_number":{"description":"The Dispatch number.","nullable":true,"type":"string"},"factory_delivery_at":{"description":"Factory Delivery At.","format":"date-time","nullable":true,"type":"string"},"factory_estimated_delivery_at":{"description":"Forecast Factory Delivery At.","format":"date-time","nullable":true,"type":"string"},"gross_weight_kg":{"description":"Gross weight in kilograms.","format":"number","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the SOI.","type":"integer"},"item_status":{"description":"Item Status","nullable":true,"type":"string"},"line_number":{"description":"The line number associated with this SOI.","nullable":true,"type":"integer"},"line_reference":{"description":"The line reference associated with this item.","type":"string"},"measurement_unit_sap":{"description":"Measurement unit from SAP.","nullable":true,"type":"string"},"necessity_type":{"description":"Necessity type","nullable":true,"type":"string"},"net_weight_kg":{"description":"Net weight in kilograms.","format":"number","nullable":true,"type":"string"},"order_currency_code":{"description":"Order Currency Code.","nullable":true,"type":"string"},"order_item_reference":{"description":"Order Item Reference.","nullable":true,"type":"string"},"order_request_number":{"description":"Order Request Number.","nullable":true,"type":"string"},"order_unit_value":{"description":"Order Unit Value.","format":"number","nullable":true,"type":"string"},"order_value":{"description":"Order Value.","format":"number","nullable":true,"type":"string"},"product_code":{"description":"Code (SKU) of the product. As an alternative, you can also use product_id","type":"string"},"product_id":{"description":"Unique identifier for the Product. As an alternative, you can also use product_code","type":"integer"},"quantity":{"description":"The quantity of products associated with this SOI.","format":"number","nullable":true,"type":"string"},"shipment_containers_quantity":{"description":"Shipment Containers Quantity.","format":"number","nullable":true,"type":"string"},"shipment_equipment_type":{"description":"Shipment Equipment Type.","nullable":true,"type":"string"},"shipment_planned_arrival_at":{"description":"Shipment Planned Arrival At.","format":"date-time","nullable":true,"type":"string"},"shipment_planned_boarding_at":{"description":"Shipment Planned Boarding At.","format":"date-time","nullable":true,"type":"string"},"supplier_estimated_ready_at":{"description":"Supplier Estimated Readiness At.","format":"date-time","nullable":true,"type":"string"},"supplier_planned_ready_at":{"description":"Supplier Planned Readiness At.","format":"date-time","nullable":true,"type":"string"},"supplier_ready_at":{"description":"Supplier Readiness At.","format":"date-time","nullable":true,"type":"string"},"ubc":{"description":"UBC Code","nullable":true,"type":"string"}},"type":"object"}},"title":"UpdateSalesOrderItemParams","type":"object"},"ErrorResponse":{"description":"This schema defines an 'Error Response' data structure.","properties":{"code":{"description":"Represents a specific Error code.","enum":["NOT_FOUND","BAD_REQUEST","INTERNAL_SERVER_ERROR","UNAUTHORIZED","UNPROCESSABLE_ENTITY"],"type":"string"},"fields":{"description":"Collection of field validation Errors (if applicable).","items":{"description":"Contains details of field-specific validation errors.","properties":{"message":{"description":"Detailed Error Message. Offers a detailed error message related to the field validation error.","type":"string"},"name":{"description":"Validated Field Name. Specifies the name of the field that encountered a validation error.","type":"string"}},"type":"object"},"nullable":true,"type":"array"},"message":{"description":"Generic Error Message. Provides a general description of the encountered error.","type":"string"}},"required":["code","message"],"title":"ErrorResponse","type":"object"},"CreateProductParams":{"description":"Available parameters to create a Product.","example":{"params":{"multiple_package_per_container_ft20":500,"category":"Suspension","package_measurement_unit":"PAIRS","extra":null,"package_capacity":"4","multiple_package_type":"BOXES","family":"Suspension and Handling","pallets_per_container_ft40":20,"code":"REF1234","translated_descriptions":null,"manufacturer":"Schneider-Rutherford","multiple_package_measurement_unit":"BOXES","description":"Shock Absorbers","pallets_per_container_ft20":10,"package_code":"PR017","content_type":"PAIRS","content_capacity":"1.0","content_measurement_unit":"BOXES","packages_per_container_ft20":1000,"additional_details":null,"multiple_code":"REF1234","cubage_per_package":"0.03","gross_weight_per_package":"10.5","packages_per_pallet":50,"mercosul_code":"8708.80.00","dumping":false,"packages_per_container_ft40":2000,"internal_codes":[{"code":"REF5678","label":"Client internal code"},{"code":"CODE-2","label":"Supplier code"}],"net_weight_per_package":"9.8","product_foreign_operators":[],"multiple_package_per_container_ft40":1000,"multiple_package_capacity":"30","content_code":"REF1234"}},"properties":{"multiple_package_per_container_ft20":{"description":"Estimated number of packages fitting by volume (cubage) in a 20ft container.","nullable":true,"type":"integer"},"category":{"description":"Category of the product.","nullable":true,"type":"string"},"package_measurement_unit":{"description":"Package Measurement Unit of the product.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"extra":{"description":"Extra information related to the product.","nullable":true,"type":"json"},"package_capacity":{"description":"Package capacity of the product.","format":"decimal","nullable":true,"type":"string"},"multiple_package_type":{"description":"Type of the multi-package unit (e.g. box, pallet, bag).","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"family":{"description":"Family of the product.","nullable":true,"type":"string"},"pallets_per_container_ft40":{"description":"Estimated number of pallets that fit into a 40ft container.","nullable":true,"type":"integer"},"has_unitization":{"description":"If Product has Unitization","nullable":true,"type":"boolean"},"code":{"description":"Code (SKU) of the product.","type":"string"},"translated_descriptions":{"description":"Translated descriptions related to the product.","nullable":true,"type":"json"},"manufacturer":{"description":"Manufacturer of the product.","nullable":true,"type":"string"},"multiple_package_measurement_unit":{"description":"Multiple Package Measurement Unit of the product.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"has_containerization":{"description":"If Product has Containerization","nullable":true,"type":"boolean"},"package_type":{"description":"Package Type of the product.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"description":{"description":"Description of the product.","type":"string"},"pallets_per_container_ft20":{"description":"Estimated number of pallets that fit into a 20ft container.","nullable":true,"type":"integer"},"package_code":{"description":"Package code of the product.","nullable":true,"type":"string"},"content_type":{"description":"Measurement unit type for the package contents (e.g. kg, liter, unit).","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"has_palletization":{"description":"If Product has Palletization","nullable":true,"type":"boolean"},"content_capacity":{"description":"The capacity value (e.g. 1.5 for 1.5L or 1.5kg) of the content per package.","format":"decimal","type":"string"},"content_measurement_unit":{"description":"Unit used to quantify the product content.","enum":["BOTTLES","GRAMS","KILOGRAMS","TONS","CENTIMETERS","SQUARE_CENTIMETERS","METERS","SQUARE_METERS","CUBIC_METERS","BUCKETS","AMPOULES","TRAYS","BARS","TUBES","BLOCKS","COILS","CAPSULES","CARDS","HUNDREDS","GROUPS","CONTAINERS","BOXES","DISPLAYS","DOZENS","PACKAGING","BALES","PAPERS","FLASKS","GALLONS","ISOTANK","SETS","KITS","CANS","LITERS","MILLILITERS","THOUSAND","MEGAWATT_HOUR","PACKAGES","PALLETS","PAIRS","PIECES","POTS","CARATS","REAM","ROLLS","SACKS","BAGS","DRUMS","TANKS","PIPES","UNITS","BARRELS","GLASSES","POUNDS","OUNCES"],"nullable":true,"type":"string"},"packages_per_container_ft20":{"description":"Estimated number of packages that fit into a 20ft container.","nullable":true,"type":"integer"},"additional_details":{"description":"Additional details of the product.","nullable":true,"type":"string"},"multiple_code":{"description":"Code identifying the multi-package configuration.","nullable":true,"type":"string"},"cubage_per_package":{"description":"Cubage (volume) per package, in cubic meters.","format":"decimal","nullable":true,"type":"string"},"has_content":{"description":"If Product has Content","nullable":true,"type":"boolean"},"gross_weight_per_package":{"description":"Gross weight per individual package, including packaging material.","format":"decimal","nullable":true,"type":"string"},"packages_per_pallet":{"description":"Total number of packages that fit on a standard pallet.","nullable":true,"type":"integer"},"mercosul_code":{"description":"Mercosul Code (NCM) of the product.","nullable":true,"type":"string"},"dumping":{"description":"If Product is subject to dumping","nullable":true,"type":"boolean"},"packages_per_container_ft40":{"description":"Estimated number of packages that fit into a 40ft container.","nullable":true,"type":"integer"},"internal_codes":{"description":"An array of internal codes of this product.","items":{"properties":{"code":{"description":"Code for the Internal Code.","type":"string"},"label":{"description":"Label for the Internal Code.","type":"string"}},"type":"object"},"type":"array"},"net_weight_per_package":{"description":"Net weight per individual package, excluding packaging material.","format":"decimal","nullable":true,"type":"string"},"product_foreign_operators":{"description":"An array of Actor IDs to be associated as foreign operators for the product","items":{"type":"integer"},"type":"array"},"multiple_package_per_container_ft40":{"description":"Estimated number of packages fitting by volume (cubage) in a 40ft container.","nullable":true,"type":"integer"},"multiple_package_capacity":{"description":"Multiple package capacity of the product.","format":"decimal","nullable":true,"type":"string"},"content_code":{"description":"Internal or external code identifying the product content type.","nullable":true,"type":"string"}},"title":"CreateProductParams","type":"object"},"Vehicle":{"description":"This schema defines a 'Vehicle' data structure.","example":{"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"},"properties":{"id":{"description":"Unique identifier for the Vehicle.","type":"integer"},"is_refrigerated":{"description":"Indicates whether the Vehicle is refrigerated (true) or not (false).","type":"boolean"},"plate":{"description":"The plate of the Vehicle.","type":"string"},"speed_limit_dry":{"description":"The speed limit for the Vehicle in dry conditions.","nullable":true,"type":"integer"},"speed_limit_wet":{"description":"The speed limit for the Vehicle in wet conditions.","nullable":true,"type":"integer"},"tare_weight_kg":{"description":"The weight of the empty Vehicle in kilograms.","format":"decimal","nullable":true,"type":"string"},"temperature_max":{"description":"The maximum temperature the refrigerated Vehicle can maintain.","nullable":true,"type":"integer"},"temperature_min":{"description":"The minimum temperature the refrigerated Vehicle can maintain.","nullable":true,"type":"integer"},"tracker_brand":{"description":"The brand of the tracker on the Vehicle.","enum":["SASCAR","OMNILINK"],"type":"string"},"tracker_id":{"description":"The unique identifier of the tracker on the Vehicle.","nullable":true,"type":"integer"},"type":{"description":"The type of the Vehicle.","enum":["MECHANICAL_HORSE_DOUBLE_AXIS","HORSE","TRUCK","SEMI_TRUCK","THREE_QUARTER_TON_TRUCK","VAN","CAR","PASSENGER_VEHICLE","MOTORCYCLE"],"type":"string"}},"required":["id","type","plate","is_refrigerated"],"title":"Vehicle","type":"object"},"CeMercanteDataContainerSeal":{"description":"This schema defines a 'CeMercanteDataContainerSeal' data structure.","example":{"container_code":"TGHU1234567","seal_code":"SF1234","secondary_seal_code":null},"properties":{"container_code":{"description":"The container identifier (identificacao) from the CE Mercante items endpoint.","type":"string"},"seal_code":{"description":"The primary seal number (lacre[0]) of the container.","nullable":true,"type":"string"},"secondary_seal_code":{"description":"The secondary seal number (lacre[1]) of the container.","nullable":true,"type":"string"}},"title":"CeMercanteDataContainerSeal","type":"object"},"ImportDeclaration":{"description":"This schema defines a 'Import Declaration' data structure.","example":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","id":1,"import_licenses":[{"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"},"properties":{"channel":{"description":"The Import Declaration channel.","enum":["GREEN","RED","YELLOW","GRAY"],"nullable":true,"type":"string"},"customs_cleared_at":{"description":"The timestamp when the Import Declaration was customs cleared.","format":"date-time","nullable":true,"type":"string"},"extra":{"description":"Additional information related to the Import Declaration.","nullable":true,"type":"object"},"id":{"description":"Unique identifier for the Import Declaration.","type":"integer"},"import_licenses":{"description":"The Import Licenses associated with the Import Declaration.","items":{"properties":{"number":{"description":"The Import License number.","type":"string"}},"type":"object"},"type":"array"},"inserted_at":{"description":"The timestamp when the Import Declaration was inserted.","format":"date-time","type":"string"},"last_updated_at":{"description":"The timestamp when the Import Declaration was last updated.","format":"date-time","nullable":true,"type":"string"},"number":{"description":"The Import Declaration number.","type":"string"},"registered_at":{"description":"The timestamp when the Import Declaration was registered.","format":"date-time","nullable":true,"type":"string"},"status":{"description":"The current status of the Import Declaration.","enum":["WAITING_PARAMETERIZATION","WAITING_DOCUMENT","WAITING_DISTRIBUTION","WAITING_FISCAL_ANALYSIS","READY_DISTRIBUTION","UNDER_FISCAL_ANALYSIS","DISPATCH_INTERRUPTED","DELIVERY_AUTHORIZED","CLEARED","CANCELLED","WAITING_CLEARANCE","NOT_REPORTED","IN_FORFEITURE"],"nullable":true,"type":"string"},"status_response":{"description":"The response status for the Import Declaration.","enum":["PENDING","NOT_FOUND","FOUND","INVALID"],"type":"string"},"status_updated_at":{"description":"The timestamp when the status of the Import Declaration was last updated.","format":"date-time","nullable":true,"type":"string"}},"required":["id","number","status_response","inserted_at"],"title":"ImportDeclaration","type":"object"},"NestedUpdateNationalRoadTransportParams":{"description":"Available nested parameters to update a National Road Transport.","example":{"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":123,"transport_completed_at":"2023-10-29T00:00:00Z","transport_features":["REFRIGERATED","HAZARDOUS_PRODUCTS"],"trips":[{"driver_id":123,"driver_name":"John Doe","id":1,"phases":[{"departure_at":"2023-10-29T00:00:00Z","estimated_realized_at":"2023-10-29T00:00:00Z","realized_at":"2023-10-29T00:00:00Z","route_point_id":1},{"departure_at":"2023-10-29T00:00:00Z","estimated_realized_at":"2023-10-29T00:00:00Z","realized_at":"2023-10-29T00:00:00Z","route_point_id":2}],"position":123,"trailer_id":123,"trailer_plate":"XYZ456","transportable_ids":[123,124],"vehicle_id":null,"vehicle_plate":"ABC123"}]},"properties":{"collection_scheduled_at":{"description":"Scheduled timestamp for Cargo.","format":"date-time","nullable":true,"type":"string"},"delivery_planned_at":{"description":"Planned delivery timestamp.","format":"date-time","nullable":true,"type":"string"},"is_transport_type_dta":{"description":"Indicates whether the transport type is 'dta'.","type":"boolean"},"leg_slug":{"description":"Identifier for the National Road Transport leg.","type":"string"},"load_type":{"description":"Type of Cargo the National Road Transport is designed for.","enum":["GENERAL_CARGO","FOOD","PHARMACEUTICALS","WEAPONS","BULK"],"nullable":true,"type":"string"},"national_road_carrier":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateHandlerParams"},"description":"Information about the Road Carrier."},"quantity_pallets":{"description":"The quantity of pallets used in the National Road Transport.","nullable":true,"type":"integer"},"released_for_transport_at":{"description":"The timestamp when the Cargo is released for Transport.","format":"date-time","nullable":true,"type":"string"},"road_transport_type":{"description":"Type of National Road Transport.","enum":["LTL","FTL","FCL","BULK_CARGO"],"nullable":true,"type":"string"},"route_id":{"description":"Unique identifier for the Route.","nullable":true,"type":"integer"},"transport_completed_at":{"description":"The timestamp when the National Road Transport is completed.","format":"date-time","nullable":true,"type":"string"},"transport_features":{"items":{"description":"Special features associated with the National Road Transport.","enum":["REFRIGERATED","HAZARDOUS_PRODUCTS"],"type":"string"},"type":"array"},"trips":{"items":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateRoadTransportTripParams"},"description":"Details of the Trip associated with this National Road Transport."},"type":"array"}},"title":"NestedUpdateNationalRoadTransportParams","type":"object"},"ProductMutationListResponse":{"description":"This schema defines a 'Product Mutation List Response' data structure.","properties":{"data":{"items":{"properties":{"code":{"description":"Product code.","type":"string"},"id":{"description":"Product ID.","type":"integer"}},"required":["id","code"],"type":"object"},"type":"array"}},"title":"ProductMutationListResponse","type":"object"},"NestedUpdateMaritimeTransportShipmentParams":{"description":"Available nested parameters to update a Maritime Transport Shipment.","example":{"bl":"MEDUGB760924","booking":null,"discharge_port_id":2,"hbl":null,"loading_port_id":1,"sealine_id":1,"tracking_discharge_port":"BRRIG","tracking_loading_port":"CNNGB","tracking_number":null,"type":"FCL","vessel_id":123,"voyage_number":"CNNGBTRB"},"properties":{"bl":{"description":"Bill of Lading (BL) reference related to the Shipment.","nullable":true,"type":"string"},"booking":{"description":"Booking reference related to the Shipment.","nullable":true,"type":"string"},"discharge_port_id":{"description":"Unique identifier for the Discharge Port.","nullable":true,"type":"integer"},"hbl":{"description":"House Bill of Lading (HBL) reference related to the Shipment.","nullable":true,"type":"string"},"loading_port_id":{"description":"Unique identifier for the Loading Port.","nullable":true,"type":"integer"},"sealine_id":{"description":"Unique identifier for the Sealine.","nullable":true,"type":"integer"},"tracking_discharge_port":{"description":"The Discharge Port found by Automatic Tracking.","nullable":true,"type":"string"},"tracking_loading_port":{"description":"The Loading Port found by Automatic Tracking.","nullable":true,"type":"string"},"tracking_number":{"description":"Tracking Number reference related to the Shipment.","nullable":true,"type":"string"},"type":{"description":"The Type of Maritime Transport.","enum":["FCL","LCL","BREAKBULK","BULK_CARGO"],"nullable":true,"type":"string"},"vessel_id":{"description":"Unique identifier for the Vessel.","nullable":true,"type":"integer"},"voyage_number":{"description":"Identifier of the Voyage.","nullable":true,"type":"string"}},"title":"NestedUpdateMaritimeTransportShipmentParams","type":"object"},"ExportDeclaration":{"description":"This schema defines a 'Export Declaration' data structure.","example":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","id":1,"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"},"properties":{"channel":{"description":"The Export Declaration channel.","enum":["GREEN","ORANGE","RED"],"nullable":true,"type":"string"},"customs_cleared_at":{"description":"The timestamp when the Export Declaration was customs cleared.","format":"date-time","nullable":true,"type":"string"},"endorsed_at":{"description":"The timestamp when the Export Declaration was endorsed.","format":"date-time","nullable":true,"type":"string"},"extra":{"description":"Additional information related to the Export Declaration.","nullable":true,"type":"object"},"id":{"description":"Unique identifier for the Export Declaration.","type":"integer"},"inserted_at":{"description":"The timestamp when the Export Declaration was inserted.","format":"date-time","type":"string"},"last_updated_at":{"description":"The timestamp when the Export Declaration was last updated.","format":"date-time","nullable":true,"type":"string"},"number":{"description":"The Export Declaration number.","type":"string"},"registered_at":{"description":"The timestamp when the Export Declaration was registered.","format":"date-time","nullable":true,"type":"string"},"status":{"description":"The current status of the Export Declaration.","enum":["ACD_IN_PROCESSING","CANCELED_BY_CUSTOMS","CANCELED_BY_CUSTOMS_AT_THE_REQUEST_OF_THE_EXPORTER","CANCELED_BY_THE_EXPORTER","CANCELED_DUE_TO_EXPIRATION_OF_DEADLINE","CLEARED","CUSTOMS_CLEARANCE_AWAITING_RESOLUTION_OF_ADMINISTRATIVE_ISSUES","DECLARATION_SUBMITTED_FOR_CUSTOMS_CLEARANCE","EARLY_SHIPMENT_AUTHORIZED","EARLY_SHIPMENT_PENDING_AUTHORIZATION","EARLY_SHIPMENT_PENDING_LPCO","ENDORSED","FISCAL_ANALYSIS_COMPLETED","IN_PREPARATION","INTERRUPTED","LPCO_CLEARANCE_PENDING","REGISTERED","RELEASED_WITHOUT_CUSTOMS_INSPECTION_GREEN_CHANNEL","SELECTED_FOR_CUSTOMS_CONFERENCE","SELECTED_FOR_INSPECTION_ORANGE_OR_RED_CHANNEL","UNDER_FISCAL_ANALYSIS","RFB_CANCEL_EXPORTER_REQUEST"],"nullable":true,"type":"string"},"status_response":{"description":"The response status for the Export Declaration.","enum":["PENDING","NOT_FOUND","FOUND","INVALID"],"type":"string"}},"required":["id","number","status_response","inserted_at"],"title":"ExportDeclaration","type":"object"},"Driver":{"description":"This schema defines an 'Driver' data structure.","example":{"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"},"properties":{"birthday":{"description":"The birthday of the Driver.","format":"date","nullable":true,"type":"string"},"country":{"additionalProperties":{"$ref":"#/components/schemas/Country"},"description":"The driver's Country of origin."},"cpf":{"description":"The Brazilian CPF (ID) of the Driver.","nullable":true,"type":"string"},"id":{"description":"The unique identifier for the Driver.","type":"integer"},"license_category":{"description":"The category of the Driver's license","nullable":true,"type":"string"},"license_expiration_date":{"description":"The expiration date of the driver's license.","format":"date","nullable":true,"type":"string"},"license_number":{"description":"The Driver's license number.","nullable":true,"type":"string"},"name":{"description":"The full name of the Driver.","type":"string"},"official_document":{"description":"The official document of the Driver.","nullable":true,"type":"string"}},"required":["id","name","country"],"title":"Driver","type":"object"},"NestedUpdateHandlerParams":{"description":"Available nested parameters to update a Handler.","example":{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company","roles":[{"access_group_id":null,"role":"SUPPLIER"}]},"actor_id":1,"business_unit":"Business Unit","id":1,"operation_handler_id":1,"reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"},"properties":{"actor":{"additionalProperties":{"$ref":"#/components/schemas/CreateBasePartnershipParams"},"description":"A Actor associated with this Handler. As an alternative, you can also use actor_id","nullable":true},"actor_id":{"description":"Unique identifier for the Actor. As an alternative, you can also use actor object","nullable":true,"type":"integer"},"business_unit":{"description":"Describes the business unit associated with the Handler.","type":"string"},"id":{"description":"Unique identifier for the Handler.","type":"integer"},"operation_handler_id":{"description":"Unique identifier for the Operation Handler.","type":"integer"},"reference":{"description":"Represents am identifier for the Handler.","type":"string"},"secondary_reference":{"description":"Provides an additional reference for the Handler.","type":"string"}},"title":"NestedUpdateHandlerParams","type":"object"},"ShipmentExportDeclaration":{"description":"This schema defines a 'Shipment Export Declaration' data structure.","example":{"comments":"","export_declaration":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","id":1,"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"},"id":1},"properties":{"comments":{"description":"Additional comments or notes related to the Shipment Export Declaration.","nullable":true,"type":"string"},"export_declaration":{"additionalProperties":{"$ref":"#/components/schemas/ExportDeclaration"},"description":"The Export Declaration associated with this Shipment Export Declaration.","nullable":true},"id":{"description":"Unique identifier for the Shipment Export Declaration.","type":"integer"}},"required":["id","status"],"title":"ShipmentExportDeclaration","type":"object"},"UpdateProcessParams":{"description":"Available parameters to update a Process.","example":{"params":{"alert_level":"NORMAL","cost_model_version_id":null,"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_cost_prepaid":"1250.00","freight_forwarder":"ABC Shipping","quotation_number":"Q123456","type":"PREPAID"},"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":[]}],"parcel_shipments":[{"slug":"CourierWidget","tracking_number":"BR1234567890"}],"received_in_warehouse_at":"2023-10-29T00:00:00Z","road_transport_shipment":null,"route_id":1,"shipment_duimps":[{"comments":"","duimp":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","last_updated_at":"2023-11-04T14:30:00Z","number":"21BR00000012345","registered_at":"2023-11-04T10:00:00Z","status":"ADVANCE_DELIVERY_AWAITING_CARGO_DELIVERY","status_updated_at":"2023-11-04T15:45:00Z","version":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.5","total_net_weight":"1.2","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},"handler":{"acquirer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"agent":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"bank":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"bonded_terminal":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"cargo_owner":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"container_depot":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customs_broker":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"customs_terminal":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"exporter":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"freight_forwarder":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"funder":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"importer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"integrator":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"international_road_carrier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"manufacturer":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"national_road_carrier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"supplier":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"trading":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}],"warehouse":[{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company"},"actor_id":1,"business_unit":"Business Unit","reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"}]},"handlers":[],"lead_time_datetime_reference":"2023-10-29T00:00:00Z","order_ids":[]}},"properties":{"params":{"properties":{"alert_level":{"default":"NORMAL","description":"Alert level indicating the severity of the Process.","enum":["WARNING","DANGER","NORMAL"],"type":"string"},"brazilian_invoices":{"description":"An array of Brazilian Invoice XML files as Base64.","items":{"type":"string"},"type":"array"},"cost_model_version_id":{"description":"A Cost Model associated with this Process.","nullable":true,"type":"integer"},"foreign_trade_shipment":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpdateForeignTradeShipmentParams"},"description":"A Foreign Trade Shipment associated with this Process.","nullable":true},"handler":{"additionalProperties":{"$ref":"#/components/schemas/NestedUpsertHandlersByRoleParams"},"description":"Handlers responsible for managing this Process by Role."},"handlers":{"deprecated":true,"description":"An array of Handlers responsible for managing this Process.","items":{"$ref":"#/components/schemas/NestedUpdateHandlerParams"},"type":"array"},"lead_time_datetime_reference":{"description":"The timestamp serving as the reference point for lead time calculations. Format: ISO 8601 'date-time'.","format":"date-time","nullable":true,"type":"string"},"order_ids":{"description":"An array of Order IDs associated with this Process. As an alternative, you can also use order_reference_codes","items":{"type":"integer"},"type":"array"},"order_reference_codes":{"description":"An array of Order Reference Codes associated with this Process. As an alternative, you can also use order_ids","items":{"type":"string"},"type":"array"}},"type":"object"}},"title":"UpdateProcessParams","type":"object"},"ShipmentDuimp":{"description":"This schema defines a 'Shipment DUIMP' data structure.","example":{"comments":"","duimp":{"channel":"GREEN","customs_cleared_at":"2023-11-05T09:15:00Z","extra":"{}","id":1,"inserted_at":"2023-11-04T09:30:00Z","last_updated_at":"2023-11-04T14:30:00Z","number":"21BR00000012345","registered_at":"2023-11-04T10:00:00Z","status":"ADVANCE_DELIVERY_AWAITING_CARGO_DELIVERY","status_response":"FOUND","version":1},"id":1},"properties":{"comments":{"description":"Additional comments or notes related to the Shipment DUIMP.","nullable":true,"type":"string"},"duimp":{"additionalProperties":{"$ref":"#/components/schemas/Duimp"},"description":"The DUIMP associated with this Shipment DUIMP.","nullable":true},"id":{"description":"Unique identifier for the Shipment DUIMP.","type":"integer"}},"required":["id","status"],"title":"ShipmentDuimp","type":"object"},"UpsertProductParams":{"description":"Available parameters to upsert Products in batch.","example":{"params":[{"multiple_package_per_container_ft20":500,"category":"Suspension","package_measurement_unit":"PAIRS","extra":null,"package_capacity":"4","multiple_package_type":"BOXES","family":"Suspension and Handling","pallets_per_container_ft40":20,"code":"REF1234","translated_descriptions":null,"manufacturer":"Schneider-Rutherford","multiple_package_measurement_unit":"BOXES","description":"Shock Absorbers","pallets_per_container_ft20":10,"package_code":"PR017","content_type":"PAIRS","content_capacity":"1.0","content_measurement_unit":"BOXES","packages_per_container_ft20":1000,"additional_details":null,"multiple_code":"REF1234","cubage_per_package":"0.03","gross_weight_per_package":"10.5","packages_per_pallet":50,"mercosul_code":"8708.80.00","dumping":false,"packages_per_container_ft40":2000,"internal_codes":[{"code":"REF5678","label":"Client internal code"},{"code":"CODE-2","label":"Supplier code"}],"net_weight_per_package":"9.8","product_foreign_operators":[],"multiple_package_per_container_ft40":1000,"multiple_package_capacity":"30","content_code":"REF1234"}]},"properties":{"params":{"items":{"$ref":"#/components/schemas/CreateProductParams"},"type":"array"}},"title":"UpsertProductParams","type":"object"},"Route":{"description":"This schema defines a 'Route' data structure.","example":{"active":true,"id":123,"name":"Route A","points":[{"id":123,"position":1,"route_type":"LOADING"}]},"properties":{"active":{"description":"A boolean flag indicating the Route's activation status.","type":"boolean"},"id":{"description":"Unique identifier for the Route.","type":"integer"},"name":{"description":"The name of the Route","type":"string"},"points":{"description":"A collection of Route Points related to this Route.","items":{"additionalProperties":{"$ref":"#/components/schemas/RoutePoint"},"description":"Details of the Route Point associated with this Route."},"type":"array"}},"required":["id","name","active"],"title":"Route","type":"object"},"CostModelResponses":{"description":"An array containing details of multiple cost models.","properties":{"data":{"items":{"$ref":"#/components/schemas/CostModelFullObject"},"type":"array"}},"title":"CostModelResponses","type":"object"},"NestedCreateRoadTransportTripParams":{"description":"Available nested parameters to create a Foreign Trade Road Transport Trip.","example":{"driver_id":123,"driver_name":"John Doe","phases":[{"departure_at":"2023-10-29T00:00:00Z","estimated_realized_at":"2023-10-29T00:00:00Z","realized_at":"2023-10-29T00:00:00Z","route_point_id":1},{"departure_at":"2023-10-29T00:00:00Z","estimated_realized_at":"2023-10-29T00:00:00Z","realized_at":"2023-10-29T00:00:00Z","route_point_id":2}],"position":123,"trailer_plate":"XYZ456","transportable_ids":[123,124],"vehicle_id":123,"vehicle_plate":"ABC123"},"properties":{"driver_id":{"description":"Unique identifier for the Driver.","type":"integer"},"driver_name":{"description":"The name of the Driver.","nullable":true,"type":"string"},"phases":{"items":{"additionalProperties":{"$ref":"#/components/schemas/NestedCreateRoadTransportTripPhaseParams"},"description":"Details of different Phases of the Trip."},"type":"array"},"position":{"description":"The position of the Trip in order.","type":"integer"},"trailer_id":{"description":"Unique identifier for the Trailer.","type":"integer"},"trailer_plate":{"description":"The plate of the associated Trailer.","nullable":true,"type":"string"},"transportable_ids":{"items":{"description":"Unique identifiers for Transportables.","type":"integer"},"type":"array"},"vehicle_id":{"description":"Unique identifier for the Vehicle.","type":"integer"},"vehicle_plate":{"description":"The plate of the associated Vehicle.","nullable":true,"type":"string"}},"required":["position"],"title":"NestedCreateRoadTransportTripParams","type":"object"},"NestedCreatePurchaseOrderItemParams":{"description":"Available parameters to create a Purchase Order Item (POI).","example":{"net_weight_kg":null,"order_value":null,"shipment_estimated_boarding_at":null,"supplier_confirmation_at":null,"shipment_boarding_lead_time":null,"manufacturing_country_code":"BR","line_number":1,"line_reference":"1.1","customs_release_lead_time":null,"order_unit_value":null,"shipment_estimated_arrival_at":null,"import_type_sap":null,"shipment_planned_boarding_at":null,"sap_by_factor":null,"order_modal_type_sap":null,"shipping_details_delivery_date":null,"shipment_equipment_type":null,"order_item_reference":null,"factory_estimated_delivery_at":null,"delivery_note":null,"factory_delivery_lead_time":null,"adjusted_factory_delivery_lead_time":null,"product_code":"PRD-123","assessment_sotd":null,"planning_request_shipping_at":null,"order_adjusted_modal_type":null,"order_request_number":null,"concession_act":null,"customs_estimated_release_at":null,"purchase_country_code":"BR","quotation_opening_date":null,"adjusted_customs_release_lead_time":null,"measurement_unit_sap":null,"shipment_transport_lead_time":null,"order_requested_at":null,"delivery_note_issued_at":null,"gross_weight_kg":null,"supplier_ready_lead_time_days":null,"quantity":"20.0","invoice_issued_at":null,"shipment_planned_arrival_at":null,"supplier_estimated_ready_at":null,"order_currency_code":"USD","invoice_value":null,"customs_register_lead_time":null,"adjusted_shipment_transport_lead_time":null,"planning_shipping_at":null,"invoice_number":null,"adjusted_customs_register_lead_time":null,"customs_estimated_register_at":null,"shipment_containers_quantity":null,"product_id":1,"supplier_sent_at":null,"supplier_ready_at":null,"dispatching_country_code":"BR","factory_delivery_at":null,"factory_planned_delivery_at":null,"item_foreign_operators":[],"invoice_type":null,"adjusted_shipment_boarding_lead_time":null,"item_status":null,"adjusted_supplier_ready_lead_time_days":null,"supplier_planned_ready_at":null,"supplier_calculated_ready_at":null,"cubage_cubic_meters":null},"properties":{"net_weight_kg":{"description":"Net weight in kilograms.","format":"number","nullable":true,"type":"string"},"order_value":{"description":"Order Value.","format":"number","nullable":true,"type":"string"},"shipment_estimated_boarding_at":{"description":"Shipment Estimated Boarding At.","format":"date-time","nullable":true,"type":"string"},"supplier_confirmation_at":{"description":"Supplier Confirmation At.","format":"date-time","nullable":true,"type":"string"},"shipment_boarding_lead_time":{"description":"Shipment boarding Lead Time in Days.","nullable":true,"type":"integer"},"manufacturing_country_code":{"description":"Manufacturing Country Code.","nullable":true,"type":"string"},"line_number":{"description":"The line number associated with this POI.","nullable":true,"type":"integer"},"line_reference":{"description":"The line reference associated with this POI.","type":"string"},"customs_release_lead_time":{"description":"Customs release Lead Time in Days.","nullable":true,"type":"integer"},"order_unit_value":{"description":"Order Unit Value.","format":"number","nullable":true,"type":"string"},"shipment_estimated_arrival_at":{"description":"Shipment Estimated Arrival At.","format":"date-time","nullable":true,"type":"string"},"import_type_sap":{"description":"Import type from SAP.","nullable":true,"type":"string"},"division":{"description":"Item Division","nullable":true,"type":"string"},"shipment_planned_boarding_at":{"description":"Shipment Planned Boarding At.","format":"date-time","nullable":true,"type":"string"},"sap_by_factor":{"description":"POR factor from SAP.","format":"number","nullable":true,"type":"string"},"order_modal_type_sap":{"description":"Order Modal Type from SAP.","nullable":true,"type":"string"},"shipping_details_delivery_date":{"description":"Shipping Details Delivery Date.","format":"date","nullable":true,"type":"string"},"shipment_equipment_type":{"description":"Shipment Equipment Type.","nullable":true,"type":"string"},"order_item_reference":{"description":"Order Item Reference.","nullable":true,"type":"string"},"factory_estimated_delivery_at":{"description":"Factory Estimated Delivery At.","format":"date-time","nullable":true,"type":"string"},"delivery_note":{"description":"Delivery Note.","nullable":true,"type":"string"},"factory_delivery_lead_time":{"description":"Factory delivery Lead Time in Days.","nullable":true,"type":"integer"},"adjusted_factory_delivery_lead_time":{"description":"Adjusted factory delivery lead time in days.","nullable":true,"type":"integer"},"product_code":{"description":"Code (SKU) of the product. As an alternative, you can also use product_id","type":"string"},"assessment_sotd":{"description":"SOTD (Supplier On-time Delivery)","nullable":true,"type":"string"},"planning_request_shipping_at":{"description":"Request Shipping At.","format":"date-time","nullable":true,"type":"string"},"order_adjusted_modal_type":{"description":"Order Adjusted Modal Type.","nullable":true,"type":"string"},"order_request_number":{"description":"Order Request Number.","nullable":true,"type":"string"},"concession_act":{"description":"Concession Act.","nullable":true,"type":"string"},"customs_estimated_release_at":{"description":"Customs estimated date of release.","format":"date-time","nullable":true,"type":"string"},"purchase_country_code":{"description":"Purchase Country Code.","nullable":true,"type":"string"},"quotation_opening_date":{"description":"Quotation Opening Date.","format":"date","nullable":true,"type":"string"},"adjusted_customs_release_lead_time":{"description":"Adjusted customs release lead time in days.","nullable":true,"type":"integer"},"measurement_unit_sap":{"description":"Measurement unit from SAP.","nullable":true,"type":"string"},"shipment_transport_lead_time":{"description":"Shipment transport Lead Time in Days.","nullable":true,"type":"integer"},"order_requested_at":{"description":"Order requested at (PO Operador)","format":"date-time","nullable":true,"type":"string"},"delivery_note_issued_at":{"description":"Delivery Note Issued At.","format":"date","nullable":true,"type":"string"},"gross_weight_kg":{"description":"Gross weight in kilograms.","format":"number","nullable":true,"type":"string"},"supplier_ready_lead_time_days":{"description":"Supplier Readiness Lead Time Days.","nullable":true,"type":"integer"},"quantity":{"description":"The quantity of products associated with this POI.","format":"number","nullable":true,"type":"string"},"invoice_issued_at":{"description":"Invoice Issued At.","format":"date","nullable":true,"type":"string"},"shipment_planned_arrival_at":{"description":"Shipment Planned Arrival At.","format":"date-time","nullable":true,"type":"string"},"supplier_estimated_ready_at":{"description":"Supplier Estimated Readiness At.","format":"date-time","nullable":true,"type":"string"},"order_currency_code":{"description":"Order Currency Code.","nullable":true,"type":"string"},"invoice_value":{"description":"Invoice Value.","format":"number","nullable":true,"type":"string"},"customs_register_lead_time":{"description":"Customs DI registration Lead Time in Days.","nullable":true,"type":"integer"},"adjusted_shipment_transport_lead_time":{"description":"Adjusted shipment transport lead time in days.","nullable":true,"type":"integer"},"planning_shipping_at":{"description":"Shipping At.","format":"date-time","nullable":true,"type":"string"},"invoice_number":{"description":"Invoice Number.","nullable":true,"type":"string"},"adjusted_customs_register_lead_time":{"description":"Adjusted customs register lead time in days.","nullable":true,"type":"integer"},"customs_estimated_register_at":{"description":"Customs estimated date of DI registration.","format":"date-time","nullable":true,"type":"string"},"shipment_containers_quantity":{"description":"Shipment Containers Quantity.","format":"number","nullable":true,"type":"string"},"product_id":{"description":"Unique identifier for the Product. As an alternative, you can also use product_code","type":"integer"},"supplier_sent_at":{"description":"Supplier Sent At.","format":"date-time","nullable":true,"type":"string"},"supplier_ready_at":{"description":"Supplier Readiness At.","format":"date-time","nullable":true,"type":"string"},"dispatching_country_code":{"description":"Dispatching Country Code.","nullable":true,"type":"string"},"factory_delivery_at":{"description":"Factory Delivery At.","format":"date-time","nullable":true,"type":"string"},"factory_planned_delivery_at":{"description":"Factory Planned Delivery At.","format":"date-time","nullable":true,"type":"string"},"item_foreign_operators":{"description":"Unique identifiers for the Foreign Operator.","items":{"type":"integer"},"nullable":true,"type":"array"},"invoice_type":{"description":"Invoice type.","nullable":true,"type":"string"},"adjusted_shipment_boarding_lead_time":{"description":"Adjusted shipment boarding lead time in days.","nullable":true,"type":"integer"},"item_status":{"description":"Item Status","nullable":true,"type":"string"},"adjusted_supplier_ready_lead_time_days":{"description":"Adjusted supplier ready lead time in days.","nullable":true,"type":"integer"},"supplier_planned_ready_at":{"description":"Supplier Planned Readiness At.","format":"date-time","nullable":true,"type":"string"},"supplier_calculated_ready_at":{"description":"Supplier Calculated Readiness At.","format":"date-time","nullable":true,"type":"string"},"cubage_cubic_meters":{"description":"Cubage in cubic meters.","format":"number","nullable":true,"type":"string"}},"required":["line_reference"],"title":"NestedCreatePurchaseOrderItemParams","type":"object"},"UpdatePurchaseOrderItemParams":{"description":"Available parameters to update a Purchase Order Item.","properties":{"params":{"properties":{"net_weight_kg":{"description":"Net weight in kilograms.","format":"number","nullable":true,"type":"string"},"order_value":{"description":"Order Value.","format":"number","nullable":true,"type":"string"},"shipment_estimated_boarding_at":{"description":"Shipment Estimated Boarding At.","format":"date-time","nullable":true,"type":"string"},"supplier_confirmation_at":{"description":"Supplier Confirmation At.","format":"date-time","nullable":true,"type":"string"},"manufacturing_country_code":{"description":"Manufacturing Country Code.","nullable":true,"type":"string"},"line_number":{"description":"The line number associated with this POI.","nullable":true,"type":"integer"},"line_reference":{"description":"The line reference associated with this POI.","type":"string"},"customs_release_lead_time":{"description":"Customs release Lead Time in Days.","nullable":true,"type":"integer"},"order_unit_value":{"description":"Order Unit Value.","format":"number","nullable":true,"type":"string"},"shipment_estimated_arrival_at":{"description":"Shipment Estimated Arrival At.","format":"date-time","nullable":true,"type":"string"},"import_type_sap":{"description":"Import type from SAP.","nullable":true,"type":"string"},"division":{"description":"Item Division","nullable":true,"type":"string"},"shipment_planned_boarding_at":{"description":"Shipment Planned Boarding At.","format":"date-time","nullable":true,"type":"string"},"sap_by_factor":{"description":"POR factor from SAP.","format":"number","nullable":true,"type":"string"},"order_modal_type_sap":{"description":"Order Modal Type from SAP.","nullable":true,"type":"string"},"shipping_details_delivery_date":{"description":"Shipping Details Delivery Date.","format":"date","nullable":true,"type":"string"},"shipment_equipment_type":{"description":"Shipment Equipment Type.","nullable":true,"type":"string"},"order_item_reference":{"description":"Order Item Reference.","nullable":true,"type":"string"},"factory_estimated_delivery_at":{"description":"Factory Estimated Delivery At.","format":"date-time","nullable":true,"type":"string"},"delivery_note":{"description":"Delivery Note.","nullable":true,"type":"string"},"factory_delivery_lead_time":{"description":"Factory delivery Lead Time in Days.","nullable":true,"type":"integer"},"adjusted_factory_delivery_lead_time":{"description":"Adjusted factory delivery lead time in days.","nullable":true,"type":"integer"},"product_code":{"description":"Code (SKU) of the product. As an alternative, you can also use product_id","type":"string"},"assessment_sotd":{"description":"SOTD (Supplier On-time Delivery)","nullable":true,"type":"string"},"planning_request_shipping_at":{"description":"Request Shipping At.","format":"date-time","nullable":true,"type":"string"},"order_adjusted_modal_type":{"description":"Order Adjusted Modal Type.","nullable":true,"type":"string"},"order_request_number":{"description":"Order Request Number.","nullable":true,"type":"string"},"concession_act":{"description":"Concession Act.","nullable":true,"type":"string"},"customs_estimated_release_at":{"description":"Customs estimated date of release.","format":"date-time","nullable":true,"type":"string"},"purchase_country_code":{"description":"Purchase Country Code.","nullable":true,"type":"string"},"quotation_opening_date":{"description":"Quotation Opening Date.","format":"date","nullable":true,"type":"string"},"adjusted_customs_release_lead_time":{"description":"Adjusted customs release lead time in days.","nullable":true,"type":"integer"},"measurement_unit_sap":{"description":"Measurement unit from SAP.","nullable":true,"type":"string"},"shipment_transport_lead_time":{"description":"Shipment transport Lead Time in Days.","nullable":true,"type":"integer"},"id":{"description":"Unique identifier for the POI.","type":"integer"},"order_requested_at":{"description":"Order requested at (PO Operador)","format":"date-time","nullable":true,"type":"string"},"delivery_note_issued_at":{"description":"Delivery Note Issued At.","format":"date","nullable":true,"type":"string"},"gross_weight_kg":{"description":"Gross weight in kilograms.","format":"number","nullable":true,"type":"string"},"supplier_ready_lead_time_days":{"description":"Supplier Readiness Lead Time Days.","nullable":true,"type":"integer"},"quantity":{"description":"The quantity of products associated with this POI.","format":"number","nullable":true,"type":"string"},"invoice_issued_at":{"description":"Invoice Issued At.","format":"date","nullable":true,"type":"string"},"shipment_planned_arrival_at":{"description":"Shipment Planned Arrival At.","format":"date-time","nullable":true,"type":"string"},"supplier_estimated_ready_at":{"description":"Supplier Estimated Readiness At.","format":"date-time","nullable":true,"type":"string"},"order_currency_code":{"description":"Order Currency Code.","nullable":true,"type":"string"},"invoice_value":{"description":"Invoice Value.","format":"number","nullable":true,"type":"string"},"customs_register_lead_time":{"description":"Customs DI registration Lead Time in Days.","nullable":true,"type":"integer"},"adjusted_shipment_transport_lead_time":{"description":"Adjusted shipment transport lead time in days.","nullable":true,"type":"integer"},"planning_shipping_at":{"description":"Shipping At.","format":"date-time","nullable":true,"type":"string"},"invoice_number":{"description":"Invoice Number.","nullable":true,"type":"string"},"adjusted_customs_register_lead_time":{"description":"Adjusted customs register lead time in days.","nullable":true,"type":"integer"},"customs_estimated_register_at":{"description":"Customs estimated date of DI registration.","format":"date-time","nullable":true,"type":"string"},"shipment_containers_quantity":{"description":"Shipment Containers Quantity.","format":"number","nullable":true,"type":"string"},"product_id":{"description":"Unique identifier for the Product. As an alternative, you can also use product_code","type":"integer"},"supplier_sent_at":{"description":"Supplier Sent At.","format":"date-time","nullable":true,"type":"string"},"supplier_ready_at":{"description":"Supplier Readiness At.","format":"date-time","nullable":true,"type":"string"},"dispatching_country_code":{"description":"Dispatching Country Code.","nullable":true,"type":"string"},"factory_delivery_at":{"description":"Factory Delivery At.","format":"date-time","nullable":true,"type":"string"},"factory_planned_delivery_at":{"description":"Factory Planned Delivery At.","format":"date-time","nullable":true,"type":"string"},"item_foreign_operators":{"description":"Unique identifiers for the Foreign Operator.","items":{"type":"integer"},"nullable":true,"type":"array"},"invoice_type":{"description":"Invoice type.","nullable":true,"type":"string"},"adjusted_shipment_boarding_lead_time":{"description":"Adjusted shipment boarding lead time in days.","nullable":true,"type":"integer"},"item_status":{"description":"Item Status","nullable":true,"type":"string"},"adjusted_supplier_ready_lead_time_days":{"description":"Adjusted supplier ready lead time in days.","nullable":true,"type":"integer"},"supplier_planned_ready_at":{"description":"Supplier Planned Readiness At.","format":"date-time","nullable":true,"type":"string"},"supplier_calculated_ready_at":{"description":"Supplier Calculated Readiness At.","format":"date-time","nullable":true,"type":"string"},"cubage_cubic_meters":{"description":"Cubage in cubic meters.","format":"number","nullable":true,"type":"string"}},"type":"object"}},"title":"UpdatePurchaseOrderItemParams","type":"object"},"NestedCreateSalesOrderItemParams":{"description":"Available parameters to create a Sales Order Item (SOI).","example":{"cubage_cubic_meters":null,"dispatch_number":null,"factory_delivery_at":null,"factory_estimated_delivery_at":null,"gross_weight_kg":null,"item_status":null,"line_number":1,"line_reference":"1.1","measurement_unit_sap":null,"necessity_type":null,"net_weight_kg":null,"order_currency_code":"USD","order_item_reference":null,"order_request_number":null,"order_unit_value":null,"order_value":null,"product_code":"PRD-123","product_id":1,"quantity":"20.0","shipment_containers_quantity":null,"shipment_equipment_type":null,"shipment_planned_arrival_at":null,"shipment_planned_boarding_at":null,"supplier_estimated_ready_at":null,"supplier_planned_ready_at":null,"supplier_ready_at":null,"ubc":null},"properties":{"cubage_cubic_meters":{"description":"Cubage in cubic meters.","format":"number","nullable":true,"type":"string"},"dispatch_number":{"description":"The Dispatch number.","nullable":true,"type":"string"},"factory_delivery_at":{"description":"Factory Delivery At.","format":"date-time","nullable":true,"type":"string"},"factory_estimated_delivery_at":{"description":"Forecast Factory Delivery At.","format":"date-time","nullable":true,"type":"string"},"gross_weight_kg":{"description":"Gross weight in kilograms.","format":"number","nullable":true,"type":"string"},"item_status":{"description":"Item Status","nullable":true,"type":"string"},"line_number":{"description":"The line number associated with this SOI.","nullable":true,"type":"integer"},"line_reference":{"description":"The line reference associated with this item.","type":"string"},"measurement_unit_sap":{"description":"Measurement unit from SAP.","nullable":true,"type":"string"},"necessity_type":{"description":"Necessity type","nullable":true,"type":"string"},"net_weight_kg":{"description":"Net weight in kilograms.","format":"number","nullable":true,"type":"string"},"order_currency_code":{"description":"Order Currency Code.","nullable":true,"type":"string"},"order_item_reference":{"description":"Order Item Reference.","nullable":true,"type":"string"},"order_request_number":{"description":"Order Request Number.","nullable":true,"type":"string"},"order_unit_value":{"description":"Order Unit Value.","format":"number","nullable":true,"type":"string"},"order_value":{"description":"Order Value.","format":"number","nullable":true,"type":"string"},"product_code":{"description":"Code (SKU) of the product. As an alternative, you can also use product_id","type":"string"},"product_id":{"description":"Unique identifier for the Product. As an alternative, you can also use product_code","type":"integer"},"quantity":{"description":"The quantity of products associated with this SOI.","format":"number","nullable":true,"type":"string"},"shipment_containers_quantity":{"description":"Shipment Containers Quantity.","format":"number","nullable":true,"type":"string"},"shipment_equipment_type":{"description":"Shipment Equipment Type.","nullable":true,"type":"string"},"shipment_planned_arrival_at":{"description":"Shipment Planned Arrival At.","format":"date-time","nullable":true,"type":"string"},"shipment_planned_boarding_at":{"description":"Shipment Planned Boarding At.","format":"date-time","nullable":true,"type":"string"},"supplier_estimated_ready_at":{"description":"Supplier Estimated Readiness At.","format":"date-time","nullable":true,"type":"string"},"supplier_planned_ready_at":{"description":"Supplier Planned Readiness At.","format":"date-time","nullable":true,"type":"string"},"supplier_ready_at":{"description":"Supplier Readiness At.","format":"date-time","nullable":true,"type":"string"},"ubc":{"description":"UBC Code","nullable":true,"type":"string"}},"required":["line_reference"],"title":"NestedCreateSalesOrderItemParams","type":"object"},"ProcessResponse":{"description":"Schema representing the response for a single process. Contains process data.","properties":{"data":{"$ref":"#/components/schemas/Process"}},"title":"ProcessResponse","type":"object"},"RouteMinimalObject":{"description":"This schema defines a minimal 'Route' data structure with only basic information.","example":{"id":123,"name":"Route A"},"properties":{"id":{"description":"Unique identifier for the Route.","type":"integer"},"name":{"description":"The name of the Route","type":"string"}},"required":["id","name"],"title":"RouteMinimalObject","type":"object"},"ProcessesResponse":{"description":"An array containing details of multiple processes.","properties":{"data":{"items":{"$ref":"#/components/schemas/Process"},"type":"array"}},"title":"ProcessesResponse","type":"object"},"NestedCreateHandlerParams":{"description":"Available nested parameters to create a Handler.","example":{"actor":{"contact_details":"email: example@example.com","description":"Example partnership description","internal_code":"EXAMPLE-001","name":"Example Company","roles":[{"access_group_id":null,"role":"SUPPLIER"}]},"actor_id":1,"business_unit":"Business Unit","operation_handler_id":1,"reference":"Handler Reference","secondary_reference":"Handler Secondary Reference"},"properties":{"actor":{"additionalProperties":{"$ref":"#/components/schemas/CreateBasePartnershipParams"},"description":"A Actor associated with this Handler. As an alternative, you can also use actor_id","nullable":true},"actor_id":{"description":"Unique identifier for the Actor. As an alternative, you can also use actor object","nullable":true,"type":"integer"},"business_unit":{"description":"Describes the business unit associated with the Handler.","nullable":true,"type":"string"},"operation_handler_id":{"description":"Unique identifier for the Operation Handler.","type":"integer"},"reference":{"description":"Represents am identifier for the Handler.","nullable":true,"type":"string"},"secondary_reference":{"description":"Provides an additional reference for the Handler.","nullable":true,"type":"string"}},"required":["operation_handler_id"],"title":"NestedCreateHandlerParams","type":"object"},"Demurrage":{"description":"This schema defines a 'Demurrage' data structure.","example":{"daily_rate_usd":"10.5","free_time":2,"id":1},"properties":{"daily_rate_usd":{"description":"The daily rate in USD charged for Demurrage after the free time has expired.","format":"number","type":"string"},"free_time":{"description":"The number of days allowed for free time before Demurrage charges apply.","type":"integer"},"id":{"description":"Unique identifier for the Demurrage.","type":"integer"}},"required":["id","free_time","daily_rate_usd"],"title":"Demurrage","type":"object"},"RoadTransportShipment":{"description":"This schema defines a 'Road Transport Shipment' data structure.","example":{"crt":"CRT2024001","destination":"Buenos Aires, Argentina","id":123,"origin":"São Paulo, Brasil","type":"FTL"},"properties":{"crt":{"description":"CRT associated with the Shipment.","nullable":true,"type":"string"},"destination":{"description":"The destination of the Shipment.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the Road Transport Shipment.","type":"integer"},"origin":{"description":"The origin of the Shipment.","nullable":true,"type":"string"},"type":{"description":"Type of the Road Transport Shipment","enum":["FCL","FTL","LTL"],"nullable":true,"type":"string"}},"required":["id"],"title":"RoadTransportShipment","type":"object"}},"securitySchemes":{"api-key":{"in":"header","name":"api-key","type":"apiKey"}}},"info":{"title":"Flowls API Documentation","version":"1.0"},"openapi":"3.0.0","paths":{"/api/operations/{operation_id}/orders/{reference_code}/sales-order-items/{line_reference}":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationSalesOrderItemsController.update","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"123","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}},{"description":"Line Reference","example":"1","in":"path","name":"line_reference","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSalesOrderItemParams"}}},"description":"The attributes to Update a Sales Order Item","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"}}},"description":"Updated Sales Order Item response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update a Sales Order Item","tags":["SalesOrderItem"]}},"/api/vessels":{"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryVesselsController.list","parameters":[{"$ref":"#/components/parameters/locale"},{"$ref":"#/components/parameters/pagination"},{"description":"Search","in":"query","name":"search","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VesselsResponse"}}},"description":"Vessels response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Vessels","tags":["Vessel"]}},"/api/operations/{operation_id}/processes-by-reference-code/{reference_code}/uncancel":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationProcessesController.uncancel_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"PRC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMutationResponse"}}},"description":"Uncanceled Process response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Uncancel a Process by Reference Code","tags":["Process"]}},"/api/operations/{operation_id}/processes/{process_id}/costs/reopen":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationCostsController.reopen_cost","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Process ID","example":100,"in":"path","name":"process_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMutationResponse"}}},"description":"Reopened Cost response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Reopen a Cost","tags":["Cost"]}},"/api/operations/{operation_id}/processes/{id}/unfinish":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationProcessesController.unfinish","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Process ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMutationResponse"}}},"description":"Unfinished Process response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Unfinish a Process","tags":["Process"]}},"/api/vessels/{mmsi}/current-voyage":{"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryVesselsController.get_vessel_with_current_voyage","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"MMSI number of the vessel","example":"538006242","in":"path","name":"mmsi","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VesselWithCurrentVoyageResponse"}}},"description":"Vessel Current Voyage response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get Vessel Current Voyage by MMSI","tags":["Vessel"]}},"/api/products":{"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryProductsController.list","parameters":[{"$ref":"#/components/parameters/locale"},{"$ref":"#/components/parameters/pagination"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductsResponse"}}},"description":"Products response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Products","tags":["Product"]},"post":{"callbacks":{},"operationId":"FlowlsWeb.MutationProductsController.create","parameters":[{"$ref":"#/components/parameters/locale"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductParams"}}},"description":"The attributes to Create a Product","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductMutationResponse"}}},"description":"Created Product response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a Product","tags":["Product"]},"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationProductsController.upsert","parameters":[{"$ref":"#/components/parameters/locale"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertProductParams"}}},"description":"The attributes to Upsert Products in batch","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductMutationListResponse"}}},"description":"Upsert response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Upsert Products in batch","tags":["Product"]}},"/api/operations/{operation_id}/processes-by-reference-code/{reference_code}":{"delete":{"callbacks":{},"operationId":"FlowlsWeb.MutationProcessesController.delete_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"PRC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMutationResponse"}}},"description":"Deleted Process response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Delete a Process by Reference Code","tags":["Process"]},"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryProcessesController.get_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"PRC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResponse"}}},"description":"Process response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a Process by Reference Code","tags":["Process"]},"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationProcessesController.update_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"PRC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProcessParams"}}},"description":"The attributes to Update a Process","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMutationResponse"}}},"description":"Updated Process response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update a Process by Reference Code","tags":["Process"]}},"/api/operations/{operation_id}/orders/{id}":{"delete":{"callbacks":{},"operationId":"FlowlsWeb.MutationOrdersController.delete","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Order ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderMutationResponse"}}},"description":"Deleted Order response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Delete an Order","tags":["Order"]},"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryOrdersController.get","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Order ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"Order response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get an Order","tags":["Order"]},"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationOrdersController.update","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Order ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderParams"}}},"description":"The attributes to Update an Order","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderMutationResponse"}}},"description":"Updated Order response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update an Order","tags":["Order"]}},"/api/operations/{operation_id}/processes-by-reference-code/{reference_code}/documents":{"post":{"callbacks":{},"operationId":"FlowlsWeb.DocumentsController.upload_document_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"PRC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateDocumentParams"}}},"description":"The attributes to Create a Document","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}},"description":"Document response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Upload Document by Reference Code","tags":["Documents"]}},"/api/actors/{id}":{"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryActorsController.get","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Actor ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActorResponse"}}},"description":"Actor response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get an Actor","tags":["Actor"]}},"/api/routes":{"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryRoutesController.list","parameters":[{"$ref":"#/components/parameters/locale"},{"$ref":"#/components/parameters/pagination"},{"description":"Filters","explode":false,"in":"query","name":"filters","required":false,"schema":{"properties":{"active":{"description":"Filter results by their Active (true) or Inactive (false) state.","type":"boolean"},"name":{"description":"Filter results by the Route Name.","example":"Route name","type":"string"}},"type":"object"},"style":"deepObject"},{"description":"Search","in":"query","name":"search","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutesResponse"}}},"description":"Routes response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Routes","tags":["Route"]}},"/api/routes/{id}":{"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryRoutesController.get","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Route ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RouteResponse"}}},"description":"Route response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a Route","tags":["Route"]}},"/api/operations/{operation_id}/orders/{id}/cancel":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationOrdersController.cancel","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Order ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderMutationResponse"}}},"description":"Canceled Order response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Cancel an Order","tags":["Order"]}},"/api/operations/{operation_id}/orders-by-reference-code/{reference_code}/uncancel":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationOrdersController.uncancel_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"ORC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderMutationResponse"}}},"description":"Uncanceled Order response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Uncancel an Order by Reference Code","tags":["Order"]}},"/api/partnerships":{"post":{"callbacks":{},"description":"Creates a new Partnership or updates an existing one.","operationId":"FlowlsWeb.MutationPartnershipsController.create","parameters":[{"$ref":"#/components/parameters/locale"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePartnershipParams"}}},"description":"Parameters to create or update a Partnership","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnershipResponse"}}},"description":"Created or updated Partnership response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Upsert a Partnership","tags":["Actor","Partnership"]}},"/api/operations/{operation_id}/processes-by-reference-code/{reference_code}/unfinish":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationProcessesController.unfinish_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"PRC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMutationResponse"}}},"description":"Unfinished Process response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Unfinish a Process by Reference Code","tags":["Process"]}},"/api/operations/{operation_id}/processes/{process_id}/costs/close":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationCostsController.close_cost","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Process ID","example":100,"in":"path","name":"process_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMutationResponse"}}},"description":"Closed Cost response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Close a Cost","tags":["Cost"]}},"/api/operations/{operation_id}/processes/{process_id}/cost-per-expenses":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationCostsController.upsert_cost_per_expense","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Process ID","example":1,"in":"path","name":"process_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertCostPerExpenseParams"}}},"description":"The attributes to Upsert Cost Per Expenses","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostPerExpenseMutationResponse"}}},"description":"Upsert responses"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Upsert Cost Per Expenses in batch","tags":["Cost"]}},"/api/operations/{operation_id}/orders/{id}/unfinish":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationOrdersController.unfinish","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Order ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderMutationResponse"}}},"description":"Unfinished Order response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Unfinish an Order","tags":["Order"]}},"/api/cost-models/{id}":{"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryCostsController.get_model","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Model ID","example":1,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostModelResponse"}}},"description":"Cost Model response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get Cost Model by ID","tags":["Cost"]}},"/api/operations/{operation_id}/orders-by-reference-code/{reference_code}/cancel":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationOrdersController.cancel_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"ORC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderMutationResponse"}}},"description":"Canceled Order response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Cancel an Order by Reference Code","tags":["Order"]}},"/api/products/{id}":{"delete":{"callbacks":{},"operationId":"FlowlsWeb.MutationProductsController.delete","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Product ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductMutationResponse"}}},"description":"Deleted Product response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Delete a Product","tags":["Product"]},"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryProductsController.get","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Product ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductResponse"}}},"description":"Product response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a Product","tags":["Product"]},"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationProductsController.update","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Product ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProductParams"}}},"description":"The attributes to Update a Product","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductMutationResponse"}}},"description":"Updated Product response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update a Product","tags":["Product"]}},"/api/operations/{operation_id}/processes/{id}/cancel":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationProcessesController.cancel","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Process ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMutationResponse"}}},"description":"Canceled Process response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Cancel a Process","tags":["Process"]}},"/api/operations/{operation_id}/processes/{id}/uncancel":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationProcessesController.uncancel","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Process ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMutationResponse"}}},"description":"Uncanceled Process response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Uncancel a Process","tags":["Process"]}},"/api/operations/{operation_id}/processes/{process_id}/documents":{"post":{"callbacks":{},"operationId":"FlowlsWeb.DocumentsController.upload_document","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Process ID","example":100,"in":"path","name":"process_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateDocumentParams"}}},"description":"The attributes to Create a Document","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}},"description":"Document response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Upload Document","tags":["Documents"]}},"/api/operations/{operation_id}/processes/{id}":{"delete":{"callbacks":{},"operationId":"FlowlsWeb.MutationProcessesController.delete","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Process ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMutationResponse"}}},"description":"Deleted Process response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Delete a Process","tags":["Process"]},"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryProcessesController.get","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Process ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResponse"}}},"description":"Process response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a Process","tags":["Process"]},"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationProcessesController.update","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Process ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProcessParams"}}},"description":"The attributes to Update a Process","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMutationResponse"}}},"description":"Updated Process response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update a Process","tags":["Process"]}},"/api/port-schedules/{port_unlocode}":{"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryPortSchedulesController.list","parameters":[{"$ref":"#/components/parameters/locale"},{"$ref":"#/components/parameters/pagination"},{"description":"Port UN/LOCODE","example":"BRSSZ","in":"path","name":"port_unlocode","required":true,"schema":{"type":"string"}},{"description":"Minimum ETB to be considered in the format ISO 8601","example":"2024-01-01","in":"query","name":"start_date_etb","required":true,"schema":{"type":"string"}},{"description":"Maximum ETB to be considered in the format ISO 8601","example":"2024-02-01","in":"query","name":"end_date_etb","required":true,"schema":{"type":"string"}},{"description":"Filter by carrier voyage code","example":"VOY123","in":"query","name":"carrier_voyage","required":false,"schema":{"type":"string"}},{"description":"Filter by schedule number","example":"SCH456","in":"query","name":"schedule_number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortSchedulesResponse"}}},"description":"Port Schedules response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Port Schedules","tags":["PortSchedule"]}},"/api/operations/{operation_id}/orders-by-reference-code/{reference_code}/unfinish":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationOrdersController.unfinish_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"ORC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderMutationResponse"}}},"description":"Unfinished Order response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Unfinish an Order by Reference Code","tags":["Order"]}},"/api/operations/{operation_id}/orders/{id}/uncancel":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationOrdersController.uncancel","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Order ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderMutationResponse"}}},"description":"Uncanceled Order response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Uncancel an Order","tags":["Order"]}},"/api/cost-model-versions/{id}":{"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryCostsController.get_cost_model_version","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Model Version ID","example":1,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostModelVersionResponse"}}},"description":"Cost Model Version response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get Cost Model Version by ID","tags":["Cost"]}},"/api/operations/{operation_id}/processes-by-reference-code/{reference_code}/documents/{id}":{"delete":{"callbacks":{},"operationId":"FlowlsWeb.MutationDocumentsController.delete_document_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"PRC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}},{"description":"Document ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"}}},"description":"Deleted Document response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Delete Document by Reference Code","tags":["Documents"]}},"/api/products-by-code/{code}":{"delete":{"callbacks":{},"operationId":"FlowlsWeb.MutationProductsController.delete_by_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Product Code","example":"PRD-01","in":"path","name":"code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductMutationResponse"}}},"description":"Deleted Product response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Delete a Product by Code","tags":["Product"]},"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryProductsController.get_by_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Product Code","example":"PRD-01","in":"path","name":"code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductResponse"}}},"description":"Product response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a Product by Code","tags":["Product"]},"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationProductsController.update_by_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Product Code","example":"PRD-01","in":"path","name":"code","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProductParams"}}},"description":"The attributes to Update a Product","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductMutationResponse"}}},"description":"Updated Product response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update a Product by Code","tags":["Product"]}},"/api/operations/{operation_id}/processes-by-reference-code/{reference_code}/cancel":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationProcessesController.cancel_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"PRC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMutationResponse"}}},"description":"Canceled Process response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Cancel a Process by Reference Code","tags":["Process"]}},"/api/operations/{operation_id}/orders-by-reference-code/{reference_code}/finish":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationOrdersController.finish_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"ORC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderMutationResponse"}}},"description":"Finished Order response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Finish an Order by Reference Code","tags":["Order"]}},"/api/operations/{operation_id}/processes-by-reference-code/{reference_code}/finish":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationProcessesController.finish_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"PRC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMutationResponse"}}},"description":"Finished Process response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Finish a Process by Reference Code","tags":["Process"]}},"/api/cost-models":{"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryCostsController.list_models","parameters":[{"$ref":"#/components/parameters/locale"},{"$ref":"#/components/parameters/pagination"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostModelResponses"}}},"description":"Cost Models response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Cost Models of an Operation","tags":["Cost"]}},"/api/operations/{operation_id}/orders-by-reference-code/{reference_code}":{"delete":{"callbacks":{},"operationId":"FlowlsWeb.MutationOrdersController.delete_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"ORC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderMutationResponse"}}},"description":"Deleted Order response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Delete an Order by Reference Code","tags":["Order"]},"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryOrdersController.get_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"ORC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"Order response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get an Order by Reference Code","tags":["Order"]},"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationOrdersController.update_by_reference_code","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"ORC-01","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderParams"}}},"description":"The attributes to Update an Order","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderMutationResponse"}}},"description":"Updated Order response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update an Order by Reference Code","tags":["Order"]}},"/api/actors":{"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryActorsController.list","parameters":[{"$ref":"#/components/parameters/locale"},{"$ref":"#/components/parameters/pagination"},{"description":"Filters","explode":false,"in":"query","name":"filters","required":false,"schema":{"properties":{"partnership_role":{"description":"Filter results by the Actor Role.","enum":["ACQUIRER","AGENT","BANK","BONDED_TERMINAL","CARGO_OWNER","CONTAINER_DEPOT","CUSTOMER","CUSTOMS_BROKER","CUSTOMS_TERMINAL","EXPORTER","FUNDER","FREIGHT_FORWARDER","IMPORTER","INTEGRATOR","INTERNATIONAL_ROAD_CARRIER","MANUFACTURER","NATIONAL_ROAD_CARRIER","SUPPLIER","TRADING","WAREHOUSE"],"type":"string"}},"type":"object"},"style":"deepObject"},{"description":"Search","in":"query","name":"search","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActorsResponse"}}},"description":"Actors response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Actors","tags":["Actor"]}},"/api/operations/{operation_id}/processes":{"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryProcessesController.list","parameters":[{"$ref":"#/components/parameters/locale"},{"$ref":"#/components/parameters/pagination"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessesResponse"}}},"description":"Processes response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Processes of an Operation","tags":["Process"]},"post":{"callbacks":{},"operationId":"FlowlsWeb.MutationProcessesController.create","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProcessParams"}}},"description":"The attributes to Create a Process","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMutationResponse"}}},"description":"Created Process response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a Process","tags":["Process"]},"put":{"callbacks":{},"description":"Create new entries if they don't exist, and update existing entries if they do, using the reference_code as key.\n","operationId":"FlowlsWeb.MutationProcessesController.upsert","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertProcessParams"}}},"description":"The attributes to Create/Update a Processes","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultListResponse"}}},"description":"Created/Updated Processes response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Upsert a Process","tags":["Process"]}},"/api/operations/{operation_id}/processes/{process_id}/documents/{id}":{"delete":{"callbacks":{},"operationId":"FlowlsWeb.MutationDocumentsController.delete_document","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Process ID","example":100,"in":"path","name":"process_id","required":true,"schema":{"type":"integer"}},{"description":"Document ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"}}},"description":"Deleted Document response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Delete Document","tags":["Documents"]}},"/api/operations/{operation_id}/orders/{reference_code}/purchase-order-items/{line_reference}":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationPurchaseOrderItemsController.update","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Reference Code","example":"123","in":"path","name":"reference_code","required":true,"schema":{"type":"string"}},{"description":"Line Reference","example":"1","in":"path","name":"line_reference","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePurchaseOrderItemParams"}}},"description":"The attributes to Update a Purchase Order Item","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"}}},"description":"Updated Purchase Order Item response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update a Purchase Order Item","tags":["PurchaseOrderItem"]}},"/api/operations/{operation_id}/orders/{id}/finish":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationOrdersController.finish","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Order ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderMutationResponse"}}},"description":"Finished Order response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Finish an Order","tags":["Order"]}},"/api/operations/{operation_id}/orders":{"get":{"callbacks":{},"operationId":"FlowlsWeb.QueryOrdersController.list","parameters":[{"$ref":"#/components/parameters/locale"},{"$ref":"#/components/parameters/pagination"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponses"}}},"description":"Orders response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List Orders of an Operation","tags":["Order"]},"post":{"callbacks":{},"operationId":"FlowlsWeb.MutationOrdersController.create","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderParams"}}},"description":"The attributes to Create an Order","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderMutationResponse"}}},"description":"Created Order response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create an Order","tags":["Order"]},"put":{"callbacks":{},"description":"Create new entries if they don't exist, and update existing entries if they do, using the reference_code as key.\n","operationId":"FlowlsWeb.MutationOrdersController.upsert","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertOrderParams"}}},"description":"The attributes to Create/Update a Orders","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultListResponse"}}},"description":"Created/Updated Orders response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Upsert an Order","tags":["Order"]}},"/api/operations/{operation_id}/processes/{id}/finish":{"put":{"callbacks":{},"operationId":"FlowlsWeb.MutationProcessesController.finish","parameters":[{"$ref":"#/components/parameters/locale"},{"description":"Operation ID","example":1,"in":"path","name":"operation_id","required":true,"schema":{"type":"integer"}},{"description":"Process ID","example":100,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMutationResponse"}}},"description":"Finished Process response"},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/unprocessable_entity"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Finish a Process","tags":["Process"]}}},"security":[{"api-key":[]}],"servers":[{"description":"Production server","url":"https://api.flowls.app","variables":{}}],"tags":[{"description":"Endpoints for retrieving, managing, and interacting with an Operation's orders.","name":"Order"},{"description":"Endpoints for retrieving, managing, and interacting with an Operation's processes.","name":"Process"},{"description":"Endpoints for retrieving, managing, and interacting with Products.","name":"Product"}]}