Skip to navigation

Create an FTL

Company token. Creates one FTL. Put it on a trip in the Mile web app, or add it to an existing trip with add stops and its shipment_id. You can also create an FTL inside a stop when you add stops. Every problem is returned at once in msgs. See create FTLs.

Authentication

AuthorizationBearer

Send Authorization: Bearer <token>. Company endpoints take the company API token from POST /api/v1/partners/login. /transporters endpoints take the transporter token from POST /api/v1/partners/transporters/login. You can also send the token as an access_token query parameter or body field.

Request

This endpoint expects an object.
shipment_nostringRequired
Your FTL number.
bl_nostringRequired
Bill of lading number.
created_ondateRequired

Pickup day, Y-m-d.

expected_ondateRequired

Delivery day, Y-m-d. Same day as created_on or later.

shipping_linestringRequired

Name from options. Or send shipping_line_id.

payment_termstringRequired

Name from options. Or send payment_term_id.

shipping_chargesdoubleRequired>=0
0 or more.
other_chargesdoubleRequired>=0
0 or more.
customerobjectRequired

A customer (shipper) or consignee (receiver). Send id for an existing one, or name and address (plus phone for a customer) for a new one. See customers and consignees.

consigneeobjectRequired

A customer (shipper) or consignee (receiver). Send id for an existing one, or name and address (plus phone for a customer) for a new one. See customers and consignees.

containerslist of objectsRequired
At least one container.
shipping_line_idintegerOptional
payment_term_idintegerOptional
pickup_from_portbooleanOptional

true to pick the container up at destination_port instead of the customer address. Requires destination_port.

destination_portstringOptional

Port name, code or UN/LOCODE from ports. Or send destination_port_id.

destination_port_idintegerOptional
origination_portstringOptional

Optional. Name, code or UN/LOCODE. Or origination_port_id.

origination_port_idintegerOptional
stayed_portslist of stringsOptional

Optional transit ports, as names, codes, UN/LOCODEs or ids.

vendorstringOptional

Required only when options returns vendor_required: true. Or vendor_id.

vendor_idintegerOptional
vendor_categorystringOptional

Optional. Or vendor_category_id.

vendor_category_idintegerOptional
shipping_methodstringOptional

Optional. Or shipping_method_id.

shipping_method_idintegerOptional
countrystringOptional

Optional country name or short name. Or country_id.

country_idintegerOptional
tracking_nostringOptional
Optional. Generated when empty. Must be unique.
documentslist of objectsOptional
vesselstringOptional
voyage_nostringOptional
notesstringOptional
declared_valuestringOptional
insurance_valuestringOptional
shippers_referencestringOptional
consignment_referencestringOptional
pre_carriage_bystringOptional

Response

Success
statusinteger
msgstring
msgslist of strings
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error
412
Precondition Failed Error
429
Too Many Requests Error