entry_pointstringOptional"ready_order" · "nfe_received" · "spot_quote_without_nfe"Structure preserved from the versioned API contract.
Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
entry_pointstringOptional"ready_order" · "nfe_received" · "spot_quote_without_nfe"external_order_refstring | nullOptionalExternal order reference in the shipper's ERP/TMS.
maxLength120source_systemstring | nullOptionalmaxLength80carrier_shipper_idinteger | nullOptionalAuthorized Transport Manager link ID (carrier_shippers.id). Mandatory when more than one eligible link exists.
shipper_negotiation_idinteger | nullOptionalNegotiation/contract ID (shipper_negotiations.id). Mandatory when more than one eligible contract exists.
requested_versioninteger | nullOptionalRequested commercial version (e.g. 1).
contract_modestringOptional"period_contract" · "spot"operation_typestringOptional"urban_delivery" · "closed_load" · "full_load"service_datestring | null · dateOptionalorigin_citystringOptionalorigin_statestringOptionalminLength2maxLength2origin_postal_codestring | nullOptionalorigin_addressobject | nullOptionalorigin_contactobject | nullOptionalpickup_window_startstring | null · date-timeOptionalpickup_window_endstring | null · date-timeOptionaldestination_citystringOptionaldestination_statestringOptionalminLength2maxLength2destination_postal_codestring | nullOptionaldestination_addressobject | nullOptionaldestination_contactobject | nullOptionaldelivery_window_startstring | null · date-timeOptionaldelivery_window_endstring | null · date-timeOptionaltimezonestringOptionalcargo_descriptionstring | nullOptionalweight_kgnumber | nullOptionalminimum0weight_unitstringOptional"kg" · "t"volumes_countinteger | nullOptionalminimum1declared_value_centsinteger | nullOptionalminimum0vehicle_requirementsobject | nullOptionalcalculation_inputsobject | nullOptionalOperation calculation parameters (e.g. deliveries_count, Sundays_deliveries_count, After_hours_deliveries_count, package_overweight_kg, freight_value_cents, km, toll_cents, has_helper, has_escort, dedicated_vehicle).
spot_requirementsobject | nullOptionalspot_valid_untilstring | null · date-timeOptionalstopsarrayOptionalvolumesarrayOptionaldocumentsarrayOptional{
"type": "object",
"properties": {
"entry_point": {
"type": "string",
"enum": [
"ready_order",
"nfe_received",
"spot_quote_without_nfe"
],
"default": "ready_order"
},
"external_order_ref": {
"type": [
"string",
"null"
],
"maxLength": 120,
"description": "Referência externa do pedido no ERP/TMS do embarcador."
},
"source_system": {
"type": [
"string",
"null"
],
"maxLength": 80
},
"carrier_shipper_id": {
"type": [
"integer",
"null"
],
"description": "ID do vínculo autorizado com o Gestor de Transporte (`carrier_shippers.id`). Obrigatório quando houver mais de um vínculo elegível."
},
"shipper_negotiation_id": {
"type": [
"integer",
"null"
],
"description": "ID da negociação/contrato (`shipper_negotiations.id`). Obrigatório quando houver mais de um contrato elegível."
},
"requested_version": {
"type": [
"integer",
"null"
],
"description": "Versão comercial solicitada (ex.: `1`)."
},
"contract_mode": {
"type": "string",
"enum": [
"period_contract",
"spot"
],
"default": "period_contract"
},
"operation_type": {
"type": "string",
"enum": [
"urban_delivery",
"closed_load",
"full_load"
],
"default": "urban_delivery"
},
"service_date": {
"type": [
"string",
"null"
],
"format": "date"
},
"origin_city": {
"type": "string"
},
"origin_state": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"origin_postal_code": {
"type": [
"string",
"null"
]
},
"origin_address": {
"type": [
"object",
"null"
]
},
"origin_contact": {
"type": [
"object",
"null"
]
},
"pickup_window_start": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"pickup_window_end": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"destination_city": {
"type": "string"
},
"destination_state": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"destination_postal_code": {
"type": [
"string",
"null"
]
},
"destination_address": {
"type": [
"object",
"null"
]
},
"destination_contact": {
"type": [
"object",
"null"
]
},
"delivery_window_start": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"delivery_window_end": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"timezone": {
"type": "string",
"default": "America/Sao_Paulo"
},
"cargo_description": {
"type": [
"string",
"null"
]
},
"weight_kg": {
"type": [
"number",
"null"
],
"minimum": 0
},
"weight_unit": {
"type": "string",
"enum": [
"kg",
"t"
],
"default": "kg"
},
"volumes_count": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"declared_value_cents": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"vehicle_requirements": {
"type": [
"object",
"null"
]
},
"calculation_inputs": {
"type": [
"object",
"null"
],
"description": "Parâmetros de cálculo da operação (ex.: `deliveries_count`, `Sundays_deliveries_count`, `After_hours_deliveries_count`, `package_overweight_kg`, `freight_value_cents`, `km`, `toll_cents`, `has_helper`, `has_escort`, `dedicated_vehicle`)."
},
"spot_requirements": {
"type": [
"object",
"null"
]
},
"spot_valid_until": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"stops": {
"type": "array",
"items": {
"type": "object",
"required": [
"city",
"state"
],
"properties": {
"sequence_order": {
"type": "integer"
},
"stop_type": {
"type": "string",
"enum": [
"pickup",
"delivery",
"hub",
"return"
]
},
"external_stop_ref": {
"type": [
"string",
"null"
]
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postal_code": {
"type": [
"string",
"null"
]
},
"address": {
"type": [
"object",
"null"
]
},
"contact": {
"type": [
"object",
"null"
]
}
}
}
},
"volumes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"volume_identifier": {
"type": [
"string",
"null"
]
},
"quantity": {
"type": "integer"
},
"weight_kg": {
"type": [
"number",
"null"
]
},
"length_cm": {
"type": [
"number",
"null"
]
},
"width_cm": {
"type": [
"number",
"null"
]
},
"height_cm": {
"type": [
"number",
"null"
]
}
}
}
},
"documents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"document_type": {
"type": "string",
"enum": [
"nfe",
"cte"
]
},
"source_format": {
"type": "string",
"enum": [
"xml",
"pdf",
"manual_key",
"api"
]
},
"access_key": {
"type": [
"string",
"null"
],
"pattern": "^[0-9]{44}$"
},
"xml_content": {
"type": [
"string",
"null"
]
}
}
}
}
}
}